aws-sdk-rekognition 1.32.0 → 1.33.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.
@@ -10,5 +10,31 @@ module Aws::Rekognition
10
10
 
11
11
  extend Aws::Errors::DynamicErrors
12
12
 
13
+ class HumanLoopQuotaExceededException < ServiceError
14
+
15
+ # @param [Seahorse::Client::RequestContext] context
16
+ # @param [String] message
17
+ # @param [Aws::Rekognition::Types::HumanLoopQuotaExceededException] data
18
+ def initialize(context, message, data = Aws::EmptyStructure.new)
19
+ super(context, message, data)
20
+ end
21
+
22
+ # @return [String]
23
+ def resource_type
24
+ @data[:resource_type]
25
+ end
26
+
27
+ # @return [String]
28
+ def quota_code
29
+ @data[:quota_code]
30
+ end
31
+
32
+ # @return [String]
33
+ def service_code
34
+ @data[:service_code]
35
+ end
36
+
37
+ end
38
+
13
39
  end
14
40
  end
@@ -29,6 +29,32 @@ module Aws::Rekognition
29
29
  include Aws::Structure
30
30
  end
31
31
 
32
+ # Assets are the images that you use to train and evaluate a model
33
+ # version. Assets are referenced by Sagemaker GroundTruth manifest
34
+ # files.
35
+ #
36
+ # @note When making an API call, you may pass Asset
37
+ # data as a hash:
38
+ #
39
+ # {
40
+ # ground_truth_manifest: {
41
+ # s3_object: {
42
+ # bucket: "S3Bucket",
43
+ # name: "S3ObjectName",
44
+ # version: "S3ObjectVersion",
45
+ # },
46
+ # },
47
+ # }
48
+ #
49
+ # @!attribute [rw] ground_truth_manifest
50
+ # The S3 bucket that contains the Ground Truth manifest file.
51
+ # @return [Types::GroundTruthManifest]
52
+ #
53
+ class Asset < Struct.new(
54
+ :ground_truth_manifest)
55
+ include Aws::Structure
56
+ end
57
+
32
58
  # Indicates whether or not the face has a beard, and the confidence
33
59
  # level in the determination.
34
60
  #
@@ -266,12 +292,12 @@ module Aws::Rekognition
266
292
  # to identify faces. Filtered faces aren't compared. If you specify
267
293
  # `AUTO`, Amazon Rekognition chooses the quality bar. If you specify
268
294
  # `LOW`, `MEDIUM`, or `HIGH`, filtering removes all faces that don’t
269
- # meet the chosen quality bar. The default value is `AUTO`. The
270
- # quality bar is based on a variety of common use cases. Low-quality
271
- # detections can occur for a number of reasons. Some examples are an
272
- # object that's misidentified as a face, a face that's too blurry,
273
- # or a face with a pose that's too extreme to use. If you specify
274
- # `NONE`, no filtering is performed.
295
+ # meet the chosen quality bar. The quality bar is based on a variety
296
+ # of common use cases. Low-quality detections can occur for a number
297
+ # of reasons. Some examples are an object that's misidentified as a
298
+ # face, a face that's too blurry, or a face with a pose that's too
299
+ # extreme to use. If you specify `NONE`, no filtering is performed.
300
+ # The default value is `NONE`.
275
301
  #
276
302
  # To use quality filtering, the collection you are using must be
277
303
  # associated with version 3 of the face model or higher.
@@ -452,6 +478,112 @@ module Aws::Rekognition
452
478
  include Aws::Structure
453
479
  end
454
480
 
481
+ # @note When making an API call, you may pass CreateProjectRequest
482
+ # data as a hash:
483
+ #
484
+ # {
485
+ # project_name: "ProjectName", # required
486
+ # }
487
+ #
488
+ # @!attribute [rw] project_name
489
+ # The name of the project to create.
490
+ # @return [String]
491
+ #
492
+ class CreateProjectRequest < Struct.new(
493
+ :project_name)
494
+ include Aws::Structure
495
+ end
496
+
497
+ # @!attribute [rw] project_arn
498
+ # The Amazon Resource Name (ARN) of the new project. You can use the
499
+ # ARN to configure IAM access to the project.
500
+ # @return [String]
501
+ #
502
+ class CreateProjectResponse < Struct.new(
503
+ :project_arn)
504
+ include Aws::Structure
505
+ end
506
+
507
+ # @note When making an API call, you may pass CreateProjectVersionRequest
508
+ # data as a hash:
509
+ #
510
+ # {
511
+ # project_arn: "ProjectArn", # required
512
+ # version_name: "VersionName", # required
513
+ # output_config: { # required
514
+ # s3_bucket: "S3Bucket",
515
+ # s3_key_prefix: "S3KeyPrefix",
516
+ # },
517
+ # training_data: { # required
518
+ # assets: [
519
+ # {
520
+ # ground_truth_manifest: {
521
+ # s3_object: {
522
+ # bucket: "S3Bucket",
523
+ # name: "S3ObjectName",
524
+ # version: "S3ObjectVersion",
525
+ # },
526
+ # },
527
+ # },
528
+ # ],
529
+ # },
530
+ # testing_data: { # required
531
+ # assets: [
532
+ # {
533
+ # ground_truth_manifest: {
534
+ # s3_object: {
535
+ # bucket: "S3Bucket",
536
+ # name: "S3ObjectName",
537
+ # version: "S3ObjectVersion",
538
+ # },
539
+ # },
540
+ # },
541
+ # ],
542
+ # auto_create: false,
543
+ # },
544
+ # }
545
+ #
546
+ # @!attribute [rw] project_arn
547
+ # The ARN of the Amazon Rekognition Custom Labels project that manages
548
+ # the model that you want to train.
549
+ # @return [String]
550
+ #
551
+ # @!attribute [rw] version_name
552
+ # A name for the version of the model. This value must be unique.
553
+ # @return [String]
554
+ #
555
+ # @!attribute [rw] output_config
556
+ # The Amazon S3 location to store the results of training.
557
+ # @return [Types::OutputConfig]
558
+ #
559
+ # @!attribute [rw] training_data
560
+ # The dataset to use for training.
561
+ # @return [Types::TrainingData]
562
+ #
563
+ # @!attribute [rw] testing_data
564
+ # The dataset to use for testing.
565
+ # @return [Types::TestingData]
566
+ #
567
+ class CreateProjectVersionRequest < Struct.new(
568
+ :project_arn,
569
+ :version_name,
570
+ :output_config,
571
+ :training_data,
572
+ :testing_data)
573
+ include Aws::Structure
574
+ end
575
+
576
+ # @!attribute [rw] project_version_arn
577
+ # The ARN of the model version that was created. Use
578
+ # `DescribeProjectVersion` to get the current status of the training
579
+ # operation.
580
+ # @return [String]
581
+ #
582
+ class CreateProjectVersionResponse < Struct.new(
583
+ :project_version_arn)
584
+ include Aws::Structure
585
+ end
586
+
455
587
  # @note When making an API call, you may pass CreateStreamProcessorRequest
456
588
  # data as a hash:
457
589
  #
@@ -523,6 +655,32 @@ module Aws::Rekognition
523
655
  include Aws::Structure
524
656
  end
525
657
 
658
+ # A custom label detected in an image by a call to DetectCustomLabels.
659
+ #
660
+ # @!attribute [rw] name
661
+ # The name of the custom label.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] confidence
665
+ # The confidence that the model has in the detection of the custom
666
+ # label. The range is 0-100. A higher value indicates a higher
667
+ # confidence.
668
+ # @return [Float]
669
+ #
670
+ # @!attribute [rw] geometry
671
+ # The location of the detected object on the image that corresponds to
672
+ # the custom label. Includes an axis aligned coarse bounding box
673
+ # surrounding the object and a finer grain polygon for more accurate
674
+ # spatial information.
675
+ # @return [Types::Geometry]
676
+ #
677
+ class CustomLabel < Struct.new(
678
+ :name,
679
+ :confidence,
680
+ :geometry)
681
+ include Aws::Structure
682
+ end
683
+
526
684
  # @note When making an API call, you may pass DeleteCollectionRequest
527
685
  # data as a hash:
528
686
  #
@@ -644,6 +802,113 @@ module Aws::Rekognition
644
802
  include Aws::Structure
645
803
  end
646
804
 
805
+ # @note When making an API call, you may pass DescribeProjectVersionsRequest
806
+ # data as a hash:
807
+ #
808
+ # {
809
+ # project_arn: "ProjectArn", # required
810
+ # version_names: ["VersionName"],
811
+ # next_token: "ExtendedPaginationToken",
812
+ # max_results: 1,
813
+ # }
814
+ #
815
+ # @!attribute [rw] project_arn
816
+ # The Amazon Resource Name (ARN) of the project that contains the
817
+ # models you want to describe.
818
+ # @return [String]
819
+ #
820
+ # @!attribute [rw] version_names
821
+ # A list of model version names that you want to describe. You can add
822
+ # up to 10 model version names to the list. If you don't specify a
823
+ # value, all model descriptions are returned.
824
+ # @return [Array<String>]
825
+ #
826
+ # @!attribute [rw] next_token
827
+ # If the previous response was incomplete (because there is more
828
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
829
+ # pagination token in the response. You can use this pagination token
830
+ # to retrieve the next set of results.
831
+ # @return [String]
832
+ #
833
+ # @!attribute [rw] max_results
834
+ # The maximum number of results to return per paginated call. The
835
+ # largest value you can specify is 100. If you specify a value greater
836
+ # than 100, a ValidationException error occurs. The default value is
837
+ # 100.
838
+ # @return [Integer]
839
+ #
840
+ class DescribeProjectVersionsRequest < Struct.new(
841
+ :project_arn,
842
+ :version_names,
843
+ :next_token,
844
+ :max_results)
845
+ include Aws::Structure
846
+ end
847
+
848
+ # @!attribute [rw] project_version_descriptions
849
+ # A list of model descriptions. The list is sorted by the creation
850
+ # date and time of the model versions, latest to earliest.
851
+ # @return [Array<Types::ProjectVersionDescription>]
852
+ #
853
+ # @!attribute [rw] next_token
854
+ # If the previous response was incomplete (because there is more
855
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
856
+ # pagination token in the response. You can use this pagination token
857
+ # to retrieve the next set of results.
858
+ # @return [String]
859
+ #
860
+ class DescribeProjectVersionsResponse < Struct.new(
861
+ :project_version_descriptions,
862
+ :next_token)
863
+ include Aws::Structure
864
+ end
865
+
866
+ # @note When making an API call, you may pass DescribeProjectsRequest
867
+ # data as a hash:
868
+ #
869
+ # {
870
+ # next_token: "ExtendedPaginationToken",
871
+ # max_results: 1,
872
+ # }
873
+ #
874
+ # @!attribute [rw] next_token
875
+ # If the previous response was incomplete (because there is more
876
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
877
+ # pagination token in the response. You can use this pagination token
878
+ # to retrieve the next set of results.
879
+ # @return [String]
880
+ #
881
+ # @!attribute [rw] max_results
882
+ # The maximum number of results to return per paginated call. The
883
+ # largest value you can specify is 100. If you specify a value greater
884
+ # than 100, a ValidationException error occurs. The default value is
885
+ # 100.
886
+ # @return [Integer]
887
+ #
888
+ class DescribeProjectsRequest < Struct.new(
889
+ :next_token,
890
+ :max_results)
891
+ include Aws::Structure
892
+ end
893
+
894
+ # @!attribute [rw] project_descriptions
895
+ # A list of project descriptions. The list is sorted by the date and
896
+ # time the projects are created.
897
+ # @return [Array<Types::ProjectDescription>]
898
+ #
899
+ # @!attribute [rw] next_token
900
+ # If the previous response was incomplete (because there is more
901
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
902
+ # pagination token in the response. You can use this pagination token
903
+ # to retrieve the next set of results.
904
+ # @return [String]
905
+ #
906
+ class DescribeProjectsResponse < Struct.new(
907
+ :project_descriptions,
908
+ :next_token)
909
+ include Aws::Structure
910
+ end
911
+
647
912
  # @note When making an API call, you may pass DescribeStreamProcessorRequest
648
913
  # data as a hash:
649
914
  #
@@ -719,6 +984,88 @@ module Aws::Rekognition
719
984
  include Aws::Structure
720
985
  end
721
986
 
987
+ # @note When making an API call, you may pass DetectCustomLabelsRequest
988
+ # data as a hash:
989
+ #
990
+ # {
991
+ # project_version_arn: "ProjectVersionArn", # required
992
+ # image: { # required
993
+ # bytes: "data",
994
+ # s3_object: {
995
+ # bucket: "S3Bucket",
996
+ # name: "S3ObjectName",
997
+ # version: "S3ObjectVersion",
998
+ # },
999
+ # },
1000
+ # max_results: 1,
1001
+ # min_confidence: 1.0,
1002
+ # }
1003
+ #
1004
+ # @!attribute [rw] project_version_arn
1005
+ # The ARN of the model version that you want to use.
1006
+ # @return [String]
1007
+ #
1008
+ # @!attribute [rw] image
1009
+ # Provides the input image either as bytes or an S3 object.
1010
+ #
1011
+ # You pass image bytes to an Amazon Rekognition API operation by using
1012
+ # the `Bytes` property. For example, you would use the `Bytes`
1013
+ # property to pass an image loaded from a local file system. Image
1014
+ # bytes passed by using the `Bytes` property must be base64-encoded.
1015
+ # Your code may not need to encode image bytes if you are using an AWS
1016
+ # SDK to call Amazon Rekognition API operations.
1017
+ #
1018
+ # For more information, see Analyzing an Image Loaded from a Local
1019
+ # File System in the Amazon Rekognition Developer Guide.
1020
+ #
1021
+ # You pass images stored in an S3 bucket to an Amazon Rekognition API
1022
+ # operation by using the `S3Object` property. Images stored in an S3
1023
+ # bucket do not need to be base64-encoded.
1024
+ #
1025
+ # The region for the S3 bucket containing the S3 object must match the
1026
+ # region you use for Amazon Rekognition operations.
1027
+ #
1028
+ # If you use the AWS CLI to call Amazon Rekognition operations,
1029
+ # passing image bytes using the Bytes property is not supported. You
1030
+ # must first upload the image to an Amazon S3 bucket and then call the
1031
+ # operation using the S3Object property.
1032
+ #
1033
+ # For Amazon Rekognition to process an S3 object, the user must have
1034
+ # permission to access the S3 object. For more information, see
1035
+ # Resource Based Policies in the Amazon Rekognition Developer Guide.
1036
+ # @return [Types::Image]
1037
+ #
1038
+ # @!attribute [rw] max_results
1039
+ # Maximum number of results you want the service to return in the
1040
+ # response. The service returns the specified number of highest
1041
+ # confidence labels ranked from highest confidence to lowest.
1042
+ # @return [Integer]
1043
+ #
1044
+ # @!attribute [rw] min_confidence
1045
+ # Specifies the minimum confidence level for the labels to return.
1046
+ # Amazon Rekognition doesn't return any labels with a confidence
1047
+ # lower than this specified value. If you specify a value of 0, all
1048
+ # labels are return, regardless of the default thresholds that the
1049
+ # model version applies.
1050
+ # @return [Float]
1051
+ #
1052
+ class DetectCustomLabelsRequest < Struct.new(
1053
+ :project_version_arn,
1054
+ :image,
1055
+ :max_results,
1056
+ :min_confidence)
1057
+ include Aws::Structure
1058
+ end
1059
+
1060
+ # @!attribute [rw] custom_labels
1061
+ # An array of custom labels detected in the input image.
1062
+ # @return [Array<Types::CustomLabel>]
1063
+ #
1064
+ class DetectCustomLabelsResponse < Struct.new(
1065
+ :custom_labels)
1066
+ include Aws::Structure
1067
+ end
1068
+
722
1069
  # @note When making an API call, you may pass DetectFacesRequest
723
1070
  # data as a hash:
724
1071
  #
@@ -888,6 +1235,13 @@ module Aws::Rekognition
888
1235
  # },
889
1236
  # },
890
1237
  # min_confidence: 1.0,
1238
+ # human_loop_config: {
1239
+ # human_loop_name: "HumanLoopName", # required
1240
+ # flow_definition_arn: "FlowDefinitionArn", # required
1241
+ # data_attributes: {
1242
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
1243
+ # },
1244
+ # },
891
1245
  # }
892
1246
  #
893
1247
  # @!attribute [rw] image
@@ -910,9 +1264,15 @@ module Aws::Rekognition
910
1264
  # with confidence values greater than or equal to 50 percent.
911
1265
  # @return [Float]
912
1266
  #
1267
+ # @!attribute [rw] human_loop_config
1268
+ # Sets up the configuration for human evaluation, including the
1269
+ # FlowDefinition the image will be sent to.
1270
+ # @return [Types::HumanLoopConfig]
1271
+ #
913
1272
  class DetectModerationLabelsRequest < Struct.new(
914
1273
  :image,
915
- :min_confidence)
1274
+ :min_confidence,
1275
+ :human_loop_config)
916
1276
  include Aws::Structure
917
1277
  end
918
1278
 
@@ -926,9 +1286,14 @@ module Aws::Rekognition
926
1286
  # detect unsafe content.
927
1287
  # @return [String]
928
1288
  #
1289
+ # @!attribute [rw] human_loop_activation_output
1290
+ # Shows the results of the human in the loop evaluation.
1291
+ # @return [Types::HumanLoopActivationOutput]
1292
+ #
929
1293
  class DetectModerationLabelsResponse < Struct.new(
930
1294
  :moderation_labels,
931
- :moderation_model_version)
1295
+ :moderation_model_version,
1296
+ :human_loop_activation_output)
932
1297
  include Aws::Structure
933
1298
  end
934
1299
 
@@ -992,6 +1357,26 @@ module Aws::Rekognition
992
1357
  include Aws::Structure
993
1358
  end
994
1359
 
1360
+ # The evaluation results for the training of a model.
1361
+ #
1362
+ # @!attribute [rw] f1_score
1363
+ # The F1 score for the evaluation of all labels. The F1 score metric
1364
+ # evaluates the overall precision and recall performance of the model
1365
+ # as a single value. A higher value indicates better precision and
1366
+ # recall performance. A lower score indicates that precision, recall,
1367
+ # or both are performing poorly.
1368
+ # @return [Float]
1369
+ #
1370
+ # @!attribute [rw] summary
1371
+ # The S3 bucket that contains the training summary.
1372
+ # @return [Types::Summary]
1373
+ #
1374
+ class EvaluationResult < Struct.new(
1375
+ :f1_score,
1376
+ :summary)
1377
+ include Aws::Structure
1378
+ end
1379
+
995
1380
  # Indicates whether or not the eyes on the face are open, and the
996
1381
  # confidence level in the determination.
997
1382
  #
@@ -1299,17 +1684,17 @@ module Aws::Rekognition
1299
1684
  include Aws::Structure
1300
1685
  end
1301
1686
 
1302
- # Information about where the text detected by DetectText is located on
1303
- # an image.
1687
+ # Information about where an object (DetectCustomLabels) or text
1688
+ # (DetectText) is located on an image.
1304
1689
  #
1305
1690
  # @!attribute [rw] bounding_box
1306
- # An axis-aligned coarse representation of the detected text's
1691
+ # An axis-aligned coarse representation of the detected item's
1307
1692
  # location on the image.
1308
1693
  # @return [Types::BoundingBox]
1309
1694
  #
1310
1695
  # @!attribute [rw] polygon
1311
1696
  # Within the bounding box, a fine-grained polygon around the detected
1312
- # text.
1697
+ # item.
1313
1698
  # @return [Array<Types::Point>]
1314
1699
  #
1315
1700
  class Geometry < Struct.new(
@@ -1838,6 +2223,132 @@ module Aws::Rekognition
1838
2223
  include Aws::Structure
1839
2224
  end
1840
2225
 
2226
+ # The S3 bucket that contains the Ground Truth manifest file.
2227
+ #
2228
+ # @note When making an API call, you may pass GroundTruthManifest
2229
+ # data as a hash:
2230
+ #
2231
+ # {
2232
+ # s3_object: {
2233
+ # bucket: "S3Bucket",
2234
+ # name: "S3ObjectName",
2235
+ # version: "S3ObjectVersion",
2236
+ # },
2237
+ # }
2238
+ #
2239
+ # @!attribute [rw] s3_object
2240
+ # Provides the S3 bucket name and object name.
2241
+ #
2242
+ # The region for the S3 bucket containing the S3 object must match the
2243
+ # region you use for Amazon Rekognition operations.
2244
+ #
2245
+ # For Amazon Rekognition to process an S3 object, the user must have
2246
+ # permission to access the S3 object. For more information, see
2247
+ # Resource-Based Policies in the Amazon Rekognition Developer Guide.
2248
+ # @return [Types::S3Object]
2249
+ #
2250
+ class GroundTruthManifest < Struct.new(
2251
+ :s3_object)
2252
+ include Aws::Structure
2253
+ end
2254
+
2255
+ # Shows the results of the human in the loop evaluation. If there is no
2256
+ # HumanLoopArn, the input did not trigger human review.
2257
+ #
2258
+ # @!attribute [rw] human_loop_arn
2259
+ # The Amazon Resource Name (ARN) of the HumanLoop created.
2260
+ # @return [String]
2261
+ #
2262
+ # @!attribute [rw] human_loop_activation_reasons
2263
+ # Shows if and why human review was needed.
2264
+ # @return [Array<String>]
2265
+ #
2266
+ # @!attribute [rw] human_loop_activation_conditions_evaluation_results
2267
+ # Shows the result of condition evaluations, including those
2268
+ # conditions which activated a human review.
2269
+ # @return [String]
2270
+ #
2271
+ class HumanLoopActivationOutput < Struct.new(
2272
+ :human_loop_arn,
2273
+ :human_loop_activation_reasons,
2274
+ :human_loop_activation_conditions_evaluation_results)
2275
+ include Aws::Structure
2276
+ end
2277
+
2278
+ # Sets up the flow definition the image will be sent to if one of the
2279
+ # conditions is met. You can also set certain attributes of the image
2280
+ # before review.
2281
+ #
2282
+ # @note When making an API call, you may pass HumanLoopConfig
2283
+ # data as a hash:
2284
+ #
2285
+ # {
2286
+ # human_loop_name: "HumanLoopName", # required
2287
+ # flow_definition_arn: "FlowDefinitionArn", # required
2288
+ # data_attributes: {
2289
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
2290
+ # },
2291
+ # }
2292
+ #
2293
+ # @!attribute [rw] human_loop_name
2294
+ # The name of the human review used for this image. This should be
2295
+ # kept unique within a region.
2296
+ # @return [String]
2297
+ #
2298
+ # @!attribute [rw] flow_definition_arn
2299
+ # The Amazon Resource Name (ARN) of the flow definition.
2300
+ # @return [String]
2301
+ #
2302
+ # @!attribute [rw] data_attributes
2303
+ # Sets attributes of the input data.
2304
+ # @return [Types::HumanLoopDataAttributes]
2305
+ #
2306
+ class HumanLoopConfig < Struct.new(
2307
+ :human_loop_name,
2308
+ :flow_definition_arn,
2309
+ :data_attributes)
2310
+ include Aws::Structure
2311
+ end
2312
+
2313
+ # Allows you to set attributes of the image. Currently, you can declare
2314
+ # an image as free of personally identifiable information.
2315
+ #
2316
+ # @note When making an API call, you may pass HumanLoopDataAttributes
2317
+ # data as a hash:
2318
+ #
2319
+ # {
2320
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
2321
+ # }
2322
+ #
2323
+ # @!attribute [rw] content_classifiers
2324
+ # Sets whether the input image is free of personally identifiable
2325
+ # information.
2326
+ # @return [Array<String>]
2327
+ #
2328
+ class HumanLoopDataAttributes < Struct.new(
2329
+ :content_classifiers)
2330
+ include Aws::Structure
2331
+ end
2332
+
2333
+ # The number of in-progress human reviews you have has exceeded the
2334
+ # number allowed.
2335
+ #
2336
+ # @!attribute [rw] resource_type
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] quota_code
2340
+ # @return [String]
2341
+ #
2342
+ # @!attribute [rw] service_code
2343
+ # @return [String]
2344
+ #
2345
+ class HumanLoopQuotaExceededException < Struct.new(
2346
+ :resource_type,
2347
+ :quota_code,
2348
+ :service_code)
2349
+ include Aws::Structure
2350
+ end
2351
+
1841
2352
  # Provides the input image either as bytes or an S3 object.
1842
2353
  #
1843
2354
  # You pass image bytes to an Amazon Rekognition API operation by using
@@ -2438,6 +2949,30 @@ module Aws::Rekognition
2438
2949
  include Aws::Structure
2439
2950
  end
2440
2951
 
2952
+ # The S3 bucket and folder location where training output is placed.
2953
+ #
2954
+ # @note When making an API call, you may pass OutputConfig
2955
+ # data as a hash:
2956
+ #
2957
+ # {
2958
+ # s3_bucket: "S3Bucket",
2959
+ # s3_key_prefix: "S3KeyPrefix",
2960
+ # }
2961
+ #
2962
+ # @!attribute [rw] s3_bucket
2963
+ # The S3 bucket where training output is placed.
2964
+ # @return [String]
2965
+ #
2966
+ # @!attribute [rw] s3_key_prefix
2967
+ # The prefix applied to the training output files.
2968
+ # @return [String]
2969
+ #
2970
+ class OutputConfig < Struct.new(
2971
+ :s3_bucket,
2972
+ :s3_key_prefix)
2973
+ include Aws::Structure
2974
+ end
2975
+
2441
2976
  # A parent label for a label. A label can have 0, 1, or more parents.
2442
2977
  #
2443
2978
  # @!attribute [rw] name
@@ -2528,10 +3063,10 @@ module Aws::Rekognition
2528
3063
  # input image is 700x200 and the operation returns X=0.5 and Y=0.25,
2529
3064
  # then the point is at the (350,50) pixel coordinate on the image.
2530
3065
  #
2531
- # An array of `Point` objects, `Polygon`, is returned by DetectText.
2532
- # `Polygon` represents a fine-grained polygon around detected text. For
2533
- # more information, see Geometry in the Amazon Rekognition Developer
2534
- # Guide.
3066
+ # An array of `Point` objects, `Polygon`, is returned by DetectText and
3067
+ # by DetectCustomLabels. `Polygon` represents a fine-grained polygon
3068
+ # around a detected item. For more information, see Geometry in the
3069
+ # Amazon Rekognition Developer Guide.
2535
3070
  #
2536
3071
  # @!attribute [rw] x
2537
3072
  # The value of the X coordinate for a point on a `Polygon`.
@@ -2569,6 +3104,93 @@ module Aws::Rekognition
2569
3104
  include Aws::Structure
2570
3105
  end
2571
3106
 
3107
+ # A description of a Amazon Rekognition Custom Labels project.
3108
+ #
3109
+ # @!attribute [rw] project_arn
3110
+ # The Amazon Resource Name (ARN) of the project.
3111
+ # @return [String]
3112
+ #
3113
+ # @!attribute [rw] creation_timestamp
3114
+ # The Unix timestamp for the date and time that the project was
3115
+ # created.
3116
+ # @return [Time]
3117
+ #
3118
+ # @!attribute [rw] status
3119
+ # The current status of the project.
3120
+ # @return [String]
3121
+ #
3122
+ class ProjectDescription < Struct.new(
3123
+ :project_arn,
3124
+ :creation_timestamp,
3125
+ :status)
3126
+ include Aws::Structure
3127
+ end
3128
+
3129
+ # The description of a version of a model.
3130
+ #
3131
+ # @!attribute [rw] project_version_arn
3132
+ # The Amazon Resource Name (ARN) of the model version.
3133
+ # @return [String]
3134
+ #
3135
+ # @!attribute [rw] creation_timestamp
3136
+ # The Unix datetime for the date and time that training started.
3137
+ # @return [Time]
3138
+ #
3139
+ # @!attribute [rw] min_inference_units
3140
+ # The minimum number of inference units used by the model. For more
3141
+ # information, see StartProjectVersion.
3142
+ # @return [Integer]
3143
+ #
3144
+ # @!attribute [rw] status
3145
+ # The current status of the model version.
3146
+ # @return [String]
3147
+ #
3148
+ # @!attribute [rw] status_message
3149
+ # A descriptive message for an error or warning that occurred.
3150
+ # @return [String]
3151
+ #
3152
+ # @!attribute [rw] billable_training_time_in_seconds
3153
+ # The duration, in seconds, that the model version has been billed for
3154
+ # training. This value is only returned if the model version has been
3155
+ # successfully trained.
3156
+ # @return [Integer]
3157
+ #
3158
+ # @!attribute [rw] training_end_timestamp
3159
+ # The Unix date and time that training of the model ended.
3160
+ # @return [Time]
3161
+ #
3162
+ # @!attribute [rw] output_config
3163
+ # The location where training results are saved.
3164
+ # @return [Types::OutputConfig]
3165
+ #
3166
+ # @!attribute [rw] training_data_result
3167
+ # The manifest file that represents the training results.
3168
+ # @return [Types::TrainingDataResult]
3169
+ #
3170
+ # @!attribute [rw] testing_data_result
3171
+ # The manifest file that represents the testing results.
3172
+ # @return [Types::TestingDataResult]
3173
+ #
3174
+ # @!attribute [rw] evaluation_result
3175
+ # The training results. `EvaluationResult` is only returned if
3176
+ # training is successful.
3177
+ # @return [Types::EvaluationResult]
3178
+ #
3179
+ class ProjectVersionDescription < Struct.new(
3180
+ :project_version_arn,
3181
+ :creation_timestamp,
3182
+ :min_inference_units,
3183
+ :status,
3184
+ :status_message,
3185
+ :billable_training_time_in_seconds,
3186
+ :training_end_timestamp,
3187
+ :output_config,
3188
+ :training_data_result,
3189
+ :testing_data_result,
3190
+ :evaluation_result)
3191
+ include Aws::Structure
3192
+ end
3193
+
2572
3194
  # @note When making an API call, you may pass RecognizeCelebritiesRequest
2573
3195
  # data as a hash:
2574
3196
  #
@@ -2722,11 +3344,11 @@ module Aws::Rekognition
2722
3344
  # collection. If you specify `AUTO`, Amazon Rekognition chooses the
2723
3345
  # quality bar. If you specify `LOW`, `MEDIUM`, or `HIGH`, filtering
2724
3346
  # removes all faces that don’t meet the chosen quality bar. The
2725
- # default value is `AUTO`. The quality bar is based on a variety of
2726
- # common use cases. Low-quality detections can occur for a number of
2727
- # reasons. Some examples are an object that's misidentified as a
2728
- # face, a face that's too blurry, or a face with a pose that's too
2729
- # extreme to use. If you specify `NONE`, no filtering is performed.
3347
+ # quality bar is based on a variety of common use cases. Low-quality
3348
+ # detections can occur for a number of reasons. Some examples are an
3349
+ # object that's misidentified as a face, a face that's too blurry,
3350
+ # or a face with a pose that's too extreme to use. If you specify
3351
+ # `NONE`, no filtering is performed. The default value is `NONE`.
2730
3352
  #
2731
3353
  # To use quality filtering, the collection you are using must be
2732
3354
  # associated with version 3 of the face model or higher.
@@ -3265,6 +3887,42 @@ module Aws::Rekognition
3265
3887
  include Aws::Structure
3266
3888
  end
3267
3889
 
3890
+ # @note When making an API call, you may pass StartProjectVersionRequest
3891
+ # data as a hash:
3892
+ #
3893
+ # {
3894
+ # project_version_arn: "ProjectVersionArn", # required
3895
+ # min_inference_units: 1, # required
3896
+ # }
3897
+ #
3898
+ # @!attribute [rw] project_version_arn
3899
+ # The Amazon Resource Name(ARN) of the model version that you want to
3900
+ # start.
3901
+ # @return [String]
3902
+ #
3903
+ # @!attribute [rw] min_inference_units
3904
+ # The minimum number of inference units to use. A single inference
3905
+ # unit represents 1 hour of processing and can support up to 5
3906
+ # Transaction Pers Second (TPS). Use a higher number to increase the
3907
+ # TPS throughput of your model. You are charged for the number of
3908
+ # inference units that you use.
3909
+ # @return [Integer]
3910
+ #
3911
+ class StartProjectVersionRequest < Struct.new(
3912
+ :project_version_arn,
3913
+ :min_inference_units)
3914
+ include Aws::Structure
3915
+ end
3916
+
3917
+ # @!attribute [rw] status
3918
+ # The current running status of the model.
3919
+ # @return [String]
3920
+ #
3921
+ class StartProjectVersionResponse < Struct.new(
3922
+ :status)
3923
+ include Aws::Structure
3924
+ end
3925
+
3268
3926
  # @note When making an API call, you may pass StartStreamProcessorRequest
3269
3927
  # data as a hash:
3270
3928
  #
@@ -3283,6 +3941,35 @@ module Aws::Rekognition
3283
3941
 
3284
3942
  class StartStreamProcessorResponse < Aws::EmptyStructure; end
3285
3943
 
3944
+ # @note When making an API call, you may pass StopProjectVersionRequest
3945
+ # data as a hash:
3946
+ #
3947
+ # {
3948
+ # project_version_arn: "ProjectVersionArn", # required
3949
+ # }
3950
+ #
3951
+ # @!attribute [rw] project_version_arn
3952
+ # The Amazon Resource Name (ARN) of the model version that you want to
3953
+ # delete.
3954
+ #
3955
+ # This operation requires permissions to perform the
3956
+ # `rekognition:StopProjectVersion` action.
3957
+ # @return [String]
3958
+ #
3959
+ class StopProjectVersionRequest < Struct.new(
3960
+ :project_version_arn)
3961
+ include Aws::Structure
3962
+ end
3963
+
3964
+ # @!attribute [rw] status
3965
+ # The current status of the stop operation.
3966
+ # @return [String]
3967
+ #
3968
+ class StopProjectVersionResponse < Struct.new(
3969
+ :status)
3970
+ include Aws::Structure
3971
+ end
3972
+
3286
3973
  # @note When making an API call, you may pass StopStreamProcessorRequest
3287
3974
  # data as a hash:
3288
3975
  #
@@ -3389,6 +4076,29 @@ module Aws::Rekognition
3389
4076
  include Aws::Structure
3390
4077
  end
3391
4078
 
4079
+ # The S3 bucket that contains the training summary. The training summary
4080
+ # includes aggregated evaluation metrics for the entire testing dataset
4081
+ # and metrics for each individual label.
4082
+ #
4083
+ # You get the training summary S3 bucket location by calling
4084
+ # DescribeProjectVersions.
4085
+ #
4086
+ # @!attribute [rw] s3_object
4087
+ # Provides the S3 bucket name and object name.
4088
+ #
4089
+ # The region for the S3 bucket containing the S3 object must match the
4090
+ # region you use for Amazon Rekognition operations.
4091
+ #
4092
+ # For Amazon Rekognition to process an S3 object, the user must have
4093
+ # permission to access the S3 object. For more information, see
4094
+ # Resource-Based Policies in the Amazon Rekognition Developer Guide.
4095
+ # @return [Types::S3Object]
4096
+ #
4097
+ class Summary < Struct.new(
4098
+ :s3_object)
4099
+ include Aws::Structure
4100
+ end
4101
+
3392
4102
  # Indicates whether or not the face is wearing sunglasses, and the
3393
4103
  # confidence level in the determination.
3394
4104
  #
@@ -3407,6 +4117,62 @@ module Aws::Rekognition
3407
4117
  include Aws::Structure
3408
4118
  end
3409
4119
 
4120
+ # The dataset used for testing. Optionally, if `AutoCreate` is set,
4121
+ # Amazon Rekognition Custom Labels creates a testing dataset using an
4122
+ # 80/20 split of the training dataset.
4123
+ #
4124
+ # @note When making an API call, you may pass TestingData
4125
+ # data as a hash:
4126
+ #
4127
+ # {
4128
+ # assets: [
4129
+ # {
4130
+ # ground_truth_manifest: {
4131
+ # s3_object: {
4132
+ # bucket: "S3Bucket",
4133
+ # name: "S3ObjectName",
4134
+ # version: "S3ObjectVersion",
4135
+ # },
4136
+ # },
4137
+ # },
4138
+ # ],
4139
+ # auto_create: false,
4140
+ # }
4141
+ #
4142
+ # @!attribute [rw] assets
4143
+ # The assets used for testing.
4144
+ # @return [Array<Types::Asset>]
4145
+ #
4146
+ # @!attribute [rw] auto_create
4147
+ # If specified, Amazon Rekognition Custom Labels creates a testing
4148
+ # dataset with an 80/20 split of the training dataset.
4149
+ # @return [Boolean]
4150
+ #
4151
+ class TestingData < Struct.new(
4152
+ :assets,
4153
+ :auto_create)
4154
+ include Aws::Structure
4155
+ end
4156
+
4157
+ # A Sagemaker Groundtruth format manifest file representing the dataset
4158
+ # used for testing.
4159
+ #
4160
+ # @!attribute [rw] input
4161
+ # The testing dataset that was supplied for training.
4162
+ # @return [Types::TestingData]
4163
+ #
4164
+ # @!attribute [rw] output
4165
+ # The subset of the dataset that was actually tested. Some images
4166
+ # (assets) might not be tested due to file formatting and other
4167
+ # issues.
4168
+ # @return [Types::TestingData]
4169
+ #
4170
+ class TestingDataResult < Struct.new(
4171
+ :input,
4172
+ :output)
4173
+ include Aws::Structure
4174
+ end
4175
+
3410
4176
  # Information about a word or line of text detected by DetectText.
3411
4177
  #
3412
4178
  # The `DetectedText` field contains the text that Amazon Rekognition
@@ -3461,6 +4227,53 @@ module Aws::Rekognition
3461
4227
  include Aws::Structure
3462
4228
  end
3463
4229
 
4230
+ # The dataset used for training.
4231
+ #
4232
+ # @note When making an API call, you may pass TrainingData
4233
+ # data as a hash:
4234
+ #
4235
+ # {
4236
+ # assets: [
4237
+ # {
4238
+ # ground_truth_manifest: {
4239
+ # s3_object: {
4240
+ # bucket: "S3Bucket",
4241
+ # name: "S3ObjectName",
4242
+ # version: "S3ObjectVersion",
4243
+ # },
4244
+ # },
4245
+ # },
4246
+ # ],
4247
+ # }
4248
+ #
4249
+ # @!attribute [rw] assets
4250
+ # A Sagemaker GroundTruth manifest file that contains the training
4251
+ # images (assets).
4252
+ # @return [Array<Types::Asset>]
4253
+ #
4254
+ class TrainingData < Struct.new(
4255
+ :assets)
4256
+ include Aws::Structure
4257
+ end
4258
+
4259
+ # A Sagemaker Groundtruth format manifest file that represents the
4260
+ # dataset used for training.
4261
+ #
4262
+ # @!attribute [rw] input
4263
+ # The training assets that you supplied for training.
4264
+ # @return [Types::TrainingData]
4265
+ #
4266
+ # @!attribute [rw] output
4267
+ # The images (assets) that were actually trained by Amazon Rekognition
4268
+ # Custom Labels.
4269
+ # @return [Types::TrainingData]
4270
+ #
4271
+ class TrainingDataResult < Struct.new(
4272
+ :input,
4273
+ :output)
4274
+ include Aws::Structure
4275
+ end
4276
+
3464
4277
  # A face that IndexFaces detected, but didn't index. Use the `Reasons`
3465
4278
  # response attribute to determine why a face wasn't indexed.
3466
4279
  #