aws-sdk-rekognition 1.58.0 → 1.59.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.
@@ -643,6 +643,61 @@ module Aws::Rekognition
643
643
  include Aws::Structure
644
644
  end
645
645
 
646
+ # @note When making an API call, you may pass CreateDatasetRequest
647
+ # data as a hash:
648
+ #
649
+ # {
650
+ # dataset_source: {
651
+ # ground_truth_manifest: {
652
+ # s3_object: {
653
+ # bucket: "S3Bucket",
654
+ # name: "S3ObjectName",
655
+ # version: "S3ObjectVersion",
656
+ # },
657
+ # },
658
+ # dataset_arn: "DatasetArn",
659
+ # },
660
+ # dataset_type: "TRAIN", # required, accepts TRAIN, TEST
661
+ # project_arn: "ProjectArn", # required
662
+ # }
663
+ #
664
+ # @!attribute [rw] dataset_source
665
+ # The source files for the dataset. You can specify the ARN of an
666
+ # existing dataset or specify the Amazon S3 bucket location of an
667
+ # Amazon Sagemaker format manifest file. If you don't specify
668
+ # `datasetSource`, an empty dataset is created. To add labeled images
669
+ # to the dataset, You can use the console or call
670
+ # UpdateDatasetEntries.
671
+ # @return [Types::DatasetSource]
672
+ #
673
+ # @!attribute [rw] dataset_type
674
+ # The type of the dataset. Specify `train` to create a training
675
+ # dataset. Specify `test` to create a test dataset.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] project_arn
679
+ # The ARN of the Amazon Rekognition Custom Labels project to which you
680
+ # want to asssign the dataset.
681
+ # @return [String]
682
+ #
683
+ class CreateDatasetRequest < Struct.new(
684
+ :dataset_source,
685
+ :dataset_type,
686
+ :project_arn)
687
+ SENSITIVE = []
688
+ include Aws::Structure
689
+ end
690
+
691
+ # @!attribute [rw] dataset_arn
692
+ # The ARN of the created Amazon Rekognition Custom Labels dataset.
693
+ # @return [String]
694
+ #
695
+ class CreateDatasetResponse < Struct.new(
696
+ :dataset_arn)
697
+ SENSITIVE = []
698
+ include Aws::Structure
699
+ end
700
+
646
701
  # @note When making an API call, you may pass CreateProjectRequest
647
702
  # data as a hash:
648
703
  #
@@ -681,7 +736,7 @@ module Aws::Rekognition
681
736
  # s3_bucket: "S3Bucket",
682
737
  # s3_key_prefix: "S3KeyPrefix",
683
738
  # },
684
- # training_data: { # required
739
+ # training_data: {
685
740
  # assets: [
686
741
  # {
687
742
  # ground_truth_manifest: {
@@ -694,7 +749,7 @@ module Aws::Rekognition
694
749
  # },
695
750
  # ],
696
751
  # },
697
- # testing_data: { # required
752
+ # testing_data: {
698
753
  # assets: [
699
754
  # {
700
755
  # ground_truth_manifest: {
@@ -730,11 +785,15 @@ module Aws::Rekognition
730
785
  # @return [Types::OutputConfig]
731
786
  #
732
787
  # @!attribute [rw] training_data
733
- # The dataset to use for training.
788
+ # Specifies an external manifest that the services uses to train the
789
+ # model. If you specify `TrainingData` you must also specify
790
+ # `TestingData`. The project must not have any associated datasets.
734
791
  # @return [Types::TrainingData]
735
792
  #
736
793
  # @!attribute [rw] testing_data
737
- # The dataset to use for testing.
794
+ # Specifies an external manifest that the service uses to test the
795
+ # model. If you specify `TestingData` you must also specify
796
+ # `TrainingData`. The project must not have any associated datasets.
738
797
  # @return [Types::TestingData]
739
798
  #
740
799
  # @!attribute [rw] tags
@@ -743,17 +802,16 @@ module Aws::Rekognition
743
802
  # @return [Hash<String,String>]
744
803
  #
745
804
  # @!attribute [rw] kms_key_id
746
- # The identifier for your AWS Key Management Service (AWS KMS)
747
- # customer master key (CMK). You can supply the Amazon Resource Name
748
- # (ARN) of your CMK, the ID of your CMK, an alias for your CMK, or an
749
- # alias ARN. The key is used to encrypt training and test images
750
- # copied into the service for model training. Your source images are
751
- # unaffected. The key is also used to encrypt training results and
752
- # manifest files written to the output Amazon S3 bucket
753
- # (`OutputConfig`).
754
- #
755
- # If you choose to use your own CMK, you need the following
756
- # permissions on the CMK.
805
+ # The identifier for your AWS Key Management Service key (AWS KMS
806
+ # key). You can supply the Amazon Resource Name (ARN) of your KMS key,
807
+ # the ID of your KMS key, an alias for your KMS key, or an alias ARN.
808
+ # The key is used to encrypt training and test images copied into the
809
+ # service for model training. Your source images are unaffected. The
810
+ # key is also used to encrypt training results and manifest files
811
+ # written to the output Amazon S3 bucket (`OutputConfig`).
812
+ #
813
+ # If you choose to use your own KMS key, you need the following
814
+ # permissions on the KMS key.
757
815
  #
758
816
  # * kms:CreateGrant
759
817
  #
@@ -900,6 +958,235 @@ module Aws::Rekognition
900
958
  include Aws::Structure
901
959
  end
902
960
 
961
+ # Describes updates or additions to a dataset. A Single update or
962
+ # addition is an entry (JSON Line) that provides information about a
963
+ # single image. To update an existing entry, you match the `source-ref`
964
+ # field of the update entry with the `source-ref` filed of the entry
965
+ # that you want to update. If the `source-ref` field doesn't match an
966
+ # existing entry, the entry is added to dataset as a new entry.
967
+ #
968
+ # @note When making an API call, you may pass DatasetChanges
969
+ # data as a hash:
970
+ #
971
+ # {
972
+ # ground_truth: "data", # required
973
+ # }
974
+ #
975
+ # @!attribute [rw] ground_truth
976
+ # A Base64-encoded binary data object containing one or JSON lines
977
+ # that either update the dataset or are additions to the dataset. You
978
+ # change a dataset by calling UpdateDatasetEntries. If you are using
979
+ # an AWS SDK to call `UpdateDatasetEntries`, you don't need to encode
980
+ # `Changes` as the SDK encodes the data for you.
981
+ #
982
+ # For example JSON lines, see Image-Level labels in manifest files and
983
+ # and Object localization in manifest files in the *Amazon Rekognition
984
+ # Custom Labels Developer Guide*.
985
+ # @return [String]
986
+ #
987
+ class DatasetChanges < Struct.new(
988
+ :ground_truth)
989
+ SENSITIVE = []
990
+ include Aws::Structure
991
+ end
992
+
993
+ # A description for a dataset. For more information, see
994
+ # DescribeDataset.
995
+ #
996
+ # The status fields `Status`, `StatusMessage`, and `StatusMessageCode`
997
+ # reflect the last operation on the dataset.
998
+ #
999
+ # @!attribute [rw] creation_timestamp
1000
+ # The Unix timestamp for the time and date that the dataset was
1001
+ # created.
1002
+ # @return [Time]
1003
+ #
1004
+ # @!attribute [rw] last_updated_timestamp
1005
+ # The Unix timestamp for the date and time that the dataset was last
1006
+ # updated.
1007
+ # @return [Time]
1008
+ #
1009
+ # @!attribute [rw] status
1010
+ # The status of the dataset.
1011
+ # @return [String]
1012
+ #
1013
+ # @!attribute [rw] status_message
1014
+ # The status message for the dataset.
1015
+ # @return [String]
1016
+ #
1017
+ # @!attribute [rw] status_message_code
1018
+ # The status message code for the dataset operation. If a service
1019
+ # error occurs, try the API call again later. If a client error
1020
+ # occurs, check the input parameters to the dataset API call that
1021
+ # failed.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] dataset_stats
1025
+ # The status message code for the dataset.
1026
+ # @return [Types::DatasetStats]
1027
+ #
1028
+ class DatasetDescription < Struct.new(
1029
+ :creation_timestamp,
1030
+ :last_updated_timestamp,
1031
+ :status,
1032
+ :status_message,
1033
+ :status_message_code,
1034
+ :dataset_stats)
1035
+ SENSITIVE = []
1036
+ include Aws::Structure
1037
+ end
1038
+
1039
+ # Describes a dataset label. For more information, see
1040
+ # ListDatasetLabels.
1041
+ #
1042
+ # @!attribute [rw] label_name
1043
+ # The name of the label.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] label_stats
1047
+ # Statistics about the label.
1048
+ # @return [Types::DatasetLabelStats]
1049
+ #
1050
+ class DatasetLabelDescription < Struct.new(
1051
+ :label_name,
1052
+ :label_stats)
1053
+ SENSITIVE = []
1054
+ include Aws::Structure
1055
+ end
1056
+
1057
+ # Statistics about a label used in a dataset. For more information, see
1058
+ # DatasetLabelDescription.
1059
+ #
1060
+ # @!attribute [rw] entry_count
1061
+ # The total number of images that use the label.
1062
+ # @return [Integer]
1063
+ #
1064
+ # @!attribute [rw] bounding_box_count
1065
+ # The total number of images that have the label assigned to a
1066
+ # bounding box.
1067
+ # @return [Integer]
1068
+ #
1069
+ class DatasetLabelStats < Struct.new(
1070
+ :entry_count,
1071
+ :bounding_box_count)
1072
+ SENSITIVE = []
1073
+ include Aws::Structure
1074
+ end
1075
+
1076
+ # Summary information for an Amazon Rekognition Custom Labels dataset.
1077
+ # For more information, see ProjectDescription.
1078
+ #
1079
+ # @!attribute [rw] creation_timestamp
1080
+ # The Unix timestamp for the date and time that the dataset was
1081
+ # created.
1082
+ # @return [Time]
1083
+ #
1084
+ # @!attribute [rw] dataset_type
1085
+ # The type of the dataset.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] dataset_arn
1089
+ # The Amazon Resource Name (ARN) for the dataset.
1090
+ # @return [String]
1091
+ #
1092
+ # @!attribute [rw] status
1093
+ # The status for the dataset.
1094
+ # @return [String]
1095
+ #
1096
+ # @!attribute [rw] status_message
1097
+ # The status message for the dataset.
1098
+ # @return [String]
1099
+ #
1100
+ # @!attribute [rw] status_message_code
1101
+ # The status message code for the dataset operation. If a service
1102
+ # error occurs, try the API call again later. If a client error
1103
+ # occurs, check the input parameters to the dataset API call that
1104
+ # failed.
1105
+ # @return [String]
1106
+ #
1107
+ class DatasetMetadata < Struct.new(
1108
+ :creation_timestamp,
1109
+ :dataset_type,
1110
+ :dataset_arn,
1111
+ :status,
1112
+ :status_message,
1113
+ :status_message_code)
1114
+ SENSITIVE = []
1115
+ include Aws::Structure
1116
+ end
1117
+
1118
+ # The source that Amazon Rekognition Custom Labels uses to create a
1119
+ # dataset. To use an Amazon Sagemaker format manifest file, specify the
1120
+ # S3 bucket location in the `GroundTruthManifest` field. The S3 bucket
1121
+ # must be in your AWS account. To create a copy of an existing dataset,
1122
+ # specify the Amazon Resource Name (ARN) of an existing dataset in
1123
+ # `DatasetArn`.
1124
+ #
1125
+ # You need to specify a value for `DatasetArn` or `GroundTruthManifest`,
1126
+ # but not both. if you supply both values, or if you don't specify any
1127
+ # values, an InvalidParameterException exception occurs.
1128
+ #
1129
+ # For more information, see CreateDataset.
1130
+ #
1131
+ # @note When making an API call, you may pass DatasetSource
1132
+ # data as a hash:
1133
+ #
1134
+ # {
1135
+ # ground_truth_manifest: {
1136
+ # s3_object: {
1137
+ # bucket: "S3Bucket",
1138
+ # name: "S3ObjectName",
1139
+ # version: "S3ObjectVersion",
1140
+ # },
1141
+ # },
1142
+ # dataset_arn: "DatasetArn",
1143
+ # }
1144
+ #
1145
+ # @!attribute [rw] ground_truth_manifest
1146
+ # The S3 bucket that contains an Amazon Sagemaker Ground Truth format
1147
+ # manifest file.
1148
+ # @return [Types::GroundTruthManifest]
1149
+ #
1150
+ # @!attribute [rw] dataset_arn
1151
+ # The ARN of an Amazon Rekognition Custom Labels dataset that you want
1152
+ # to copy.
1153
+ # @return [String]
1154
+ #
1155
+ class DatasetSource < Struct.new(
1156
+ :ground_truth_manifest,
1157
+ :dataset_arn)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # Provides statistics about a dataset. For more information, see
1163
+ # DescribeDataset.
1164
+ #
1165
+ # @!attribute [rw] labeled_entries
1166
+ # The total number of images in the dataset that have labels.
1167
+ # @return [Integer]
1168
+ #
1169
+ # @!attribute [rw] total_entries
1170
+ # The total number of images in the dataset.
1171
+ # @return [Integer]
1172
+ #
1173
+ # @!attribute [rw] total_labels
1174
+ # The total number of labels declared in the dataset.
1175
+ # @return [Integer]
1176
+ #
1177
+ # @!attribute [rw] error_entries
1178
+ # The total number of entries that contain at least one error.
1179
+ # @return [Integer]
1180
+ #
1181
+ class DatasetStats < Struct.new(
1182
+ :labeled_entries,
1183
+ :total_entries,
1184
+ :total_labels,
1185
+ :error_entries)
1186
+ SENSITIVE = []
1187
+ include Aws::Structure
1188
+ end
1189
+
903
1190
  # @note When making an API call, you may pass DeleteCollectionRequest
904
1191
  # data as a hash:
905
1192
  #
@@ -927,6 +1214,26 @@ module Aws::Rekognition
927
1214
  include Aws::Structure
928
1215
  end
929
1216
 
1217
+ # @note When making an API call, you may pass DeleteDatasetRequest
1218
+ # data as a hash:
1219
+ #
1220
+ # {
1221
+ # dataset_arn: "DatasetArn", # required
1222
+ # }
1223
+ #
1224
+ # @!attribute [rw] dataset_arn
1225
+ # The ARN of the Amazon Rekognition Custom Labels dataset that you
1226
+ # want to delete.
1227
+ # @return [String]
1228
+ #
1229
+ class DeleteDatasetRequest < Struct.new(
1230
+ :dataset_arn)
1231
+ SENSITIVE = []
1232
+ include Aws::Structure
1233
+ end
1234
+
1235
+ class DeleteDatasetResponse < Aws::EmptyStructure; end
1236
+
930
1237
  # @note When making an API call, you may pass DeleteFacesRequest
931
1238
  # data as a hash:
932
1239
  #
@@ -1084,6 +1391,34 @@ module Aws::Rekognition
1084
1391
  include Aws::Structure
1085
1392
  end
1086
1393
 
1394
+ # @note When making an API call, you may pass DescribeDatasetRequest
1395
+ # data as a hash:
1396
+ #
1397
+ # {
1398
+ # dataset_arn: "DatasetArn", # required
1399
+ # }
1400
+ #
1401
+ # @!attribute [rw] dataset_arn
1402
+ # The Amazon Resource Name (ARN) of the dataset that you want to
1403
+ # describe.
1404
+ # @return [String]
1405
+ #
1406
+ class DescribeDatasetRequest < Struct.new(
1407
+ :dataset_arn)
1408
+ SENSITIVE = []
1409
+ include Aws::Structure
1410
+ end
1411
+
1412
+ # @!attribute [rw] dataset_description
1413
+ # The description for the dataset.
1414
+ # @return [Types::DatasetDescription]
1415
+ #
1416
+ class DescribeDatasetResponse < Struct.new(
1417
+ :dataset_description)
1418
+ SENSITIVE = []
1419
+ include Aws::Structure
1420
+ end
1421
+
1087
1422
  # @note When making an API call, you may pass DescribeProjectVersionsRequest
1088
1423
  # data as a hash:
1089
1424
  #
@@ -1157,6 +1492,7 @@ module Aws::Rekognition
1157
1492
  # {
1158
1493
  # next_token: "ExtendedPaginationToken",
1159
1494
  # max_results: 1,
1495
+ # project_names: ["ProjectName"],
1160
1496
  # }
1161
1497
  #
1162
1498
  # @!attribute [rw] next_token
@@ -1173,9 +1509,16 @@ module Aws::Rekognition
1173
1509
  # 100.
1174
1510
  # @return [Integer]
1175
1511
  #
1512
+ # @!attribute [rw] project_names
1513
+ # A list of the projects that you want Amazon Rekognition Custom
1514
+ # Labels to describe. If you don't specify a value, the response
1515
+ # includes descriptions for all the projects in your AWS account.
1516
+ # @return [Array<String>]
1517
+ #
1176
1518
  class DescribeProjectsRequest < Struct.new(
1177
1519
  :next_token,
1178
- :max_results)
1520
+ :max_results,
1521
+ :project_names)
1179
1522
  SENSITIVE = []
1180
1523
  include Aws::Structure
1181
1524
  end
@@ -1808,6 +2151,51 @@ module Aws::Rekognition
1808
2151
  include Aws::Structure
1809
2152
  end
1810
2153
 
2154
+ # A training dataset or a test dataset used in a dataset distribution
2155
+ # operation. For more information, see DistributeDatasetEntries.
2156
+ #
2157
+ # @note When making an API call, you may pass DistributeDataset
2158
+ # data as a hash:
2159
+ #
2160
+ # {
2161
+ # arn: "DatasetArn", # required
2162
+ # }
2163
+ #
2164
+ # @!attribute [rw] arn
2165
+ # The Amazon Resource Name (ARN) of the dataset that you want to use.
2166
+ # @return [String]
2167
+ #
2168
+ class DistributeDataset < Struct.new(
2169
+ :arn)
2170
+ SENSITIVE = []
2171
+ include Aws::Structure
2172
+ end
2173
+
2174
+ # @note When making an API call, you may pass DistributeDatasetEntriesRequest
2175
+ # data as a hash:
2176
+ #
2177
+ # {
2178
+ # datasets: [ # required
2179
+ # {
2180
+ # arn: "DatasetArn", # required
2181
+ # },
2182
+ # ],
2183
+ # }
2184
+ #
2185
+ # @!attribute [rw] datasets
2186
+ # The ARNS for the training dataset and test dataset that you want to
2187
+ # use. The datasets must belong to the same project. The test dataset
2188
+ # must be empty.
2189
+ # @return [Array<Types::DistributeDataset>]
2190
+ #
2191
+ class DistributeDatasetEntriesRequest < Struct.new(
2192
+ :datasets)
2193
+ SENSITIVE = []
2194
+ include Aws::Structure
2195
+ end
2196
+
2197
+ class DistributeDatasetEntriesResponse < Aws::EmptyStructure; end
2198
+
1811
2199
  # The emotions that appear to be expressed on the face, and the
1812
2200
  # confidence level in the determination. The API is only making a
1813
2201
  # determination of the physical appearance of a person's face. It is
@@ -2153,8 +2541,9 @@ module Aws::Rekognition
2153
2541
  #
2154
2542
  # @!attribute [rw] face_match_threshold
2155
2543
  # Minimum face match confidence score that must be met to return a
2156
- # result for a recognized face. Default is 80. 0 is the lowest
2157
- # confidence. 100 is the highest confidence.
2544
+ # result for a recognized face. The default is 80. 0 is the lowest
2545
+ # confidence. 100 is the highest confidence. Values between 0 and 100
2546
+ # are accepted, and values lower than 80 are set to 80.
2158
2547
  # @return [Float]
2159
2548
  #
2160
2549
  class FaceSearchSettings < Struct.new(
@@ -3549,6 +3938,148 @@ module Aws::Rekognition
3549
3938
  include Aws::Structure
3550
3939
  end
3551
3940
 
3941
+ # @note When making an API call, you may pass ListDatasetEntriesRequest
3942
+ # data as a hash:
3943
+ #
3944
+ # {
3945
+ # dataset_arn: "DatasetArn", # required
3946
+ # contains_labels: ["DatasetLabel"],
3947
+ # labeled: false,
3948
+ # source_ref_contains: "QueryString",
3949
+ # has_errors: false,
3950
+ # next_token: "ExtendedPaginationToken",
3951
+ # max_results: 1,
3952
+ # }
3953
+ #
3954
+ # @!attribute [rw] dataset_arn
3955
+ # The Amazon Resource Name (ARN) for the dataset that you want to use.
3956
+ # @return [String]
3957
+ #
3958
+ # @!attribute [rw] contains_labels
3959
+ # Specifies a label filter for the response. The response includes an
3960
+ # entry only if one or more of the labels in `ContainsLabels` exist in
3961
+ # the entry.
3962
+ # @return [Array<String>]
3963
+ #
3964
+ # @!attribute [rw] labeled
3965
+ # Specify `true` to get only the JSON Lines where the image is
3966
+ # labeled. Specify `false` to get only the JSON Lines where the image
3967
+ # isn't labeled. If you don't specify `Labeled`,
3968
+ # `ListDatasetEntries` returns JSON Lines for labeled and unlabeled
3969
+ # images.
3970
+ # @return [Boolean]
3971
+ #
3972
+ # @!attribute [rw] source_ref_contains
3973
+ # If specified, `ListDatasetEntries` only returns JSON Lines where the
3974
+ # value of `SourceRefContains` is part of the `source-ref` field. The
3975
+ # `source-ref` field contains the Amazon S3 location of the image. You
3976
+ # can use `SouceRefContains` for tasks such as getting the JSON Line
3977
+ # for a single image, or gettting JSON Lines for all images within a
3978
+ # specific folder.
3979
+ # @return [String]
3980
+ #
3981
+ # @!attribute [rw] has_errors
3982
+ # Specifies an error filter for the response. Specify `True` to only
3983
+ # include entries that have errors.
3984
+ # @return [Boolean]
3985
+ #
3986
+ # @!attribute [rw] next_token
3987
+ # If the previous response was incomplete (because there is more
3988
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
3989
+ # pagination token in the response. You can use this pagination token
3990
+ # to retrieve the next set of results.
3991
+ # @return [String]
3992
+ #
3993
+ # @!attribute [rw] max_results
3994
+ # The maximum number of results to return per paginated call. The
3995
+ # largest value you can specify is 100. If you specify a value greater
3996
+ # than 100, a ValidationException error occurs. The default value is
3997
+ # 100.
3998
+ # @return [Integer]
3999
+ #
4000
+ class ListDatasetEntriesRequest < Struct.new(
4001
+ :dataset_arn,
4002
+ :contains_labels,
4003
+ :labeled,
4004
+ :source_ref_contains,
4005
+ :has_errors,
4006
+ :next_token,
4007
+ :max_results)
4008
+ SENSITIVE = []
4009
+ include Aws::Structure
4010
+ end
4011
+
4012
+ # @!attribute [rw] dataset_entries
4013
+ # A list of entries (images) in the dataset.
4014
+ # @return [Array<String>]
4015
+ #
4016
+ # @!attribute [rw] next_token
4017
+ # If the previous response was incomplete (because there is more
4018
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
4019
+ # pagination token in the response. You can use this pagination token
4020
+ # to retrieve the next set of results.
4021
+ # @return [String]
4022
+ #
4023
+ class ListDatasetEntriesResponse < Struct.new(
4024
+ :dataset_entries,
4025
+ :next_token)
4026
+ SENSITIVE = []
4027
+ include Aws::Structure
4028
+ end
4029
+
4030
+ # @note When making an API call, you may pass ListDatasetLabelsRequest
4031
+ # data as a hash:
4032
+ #
4033
+ # {
4034
+ # dataset_arn: "DatasetArn", # required
4035
+ # next_token: "ExtendedPaginationToken",
4036
+ # max_results: 1,
4037
+ # }
4038
+ #
4039
+ # @!attribute [rw] dataset_arn
4040
+ # The Amazon Resource Name (ARN) of the dataset that you want to use.
4041
+ # @return [String]
4042
+ #
4043
+ # @!attribute [rw] next_token
4044
+ # If the previous response was incomplete (because there is more
4045
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
4046
+ # pagination token in the response. You can use this pagination token
4047
+ # to retrieve the next set of results.
4048
+ # @return [String]
4049
+ #
4050
+ # @!attribute [rw] max_results
4051
+ # The maximum number of results to return per paginated call. The
4052
+ # largest value you can specify is 100. If you specify a value greater
4053
+ # than 100, a ValidationException error occurs. The default value is
4054
+ # 100.
4055
+ # @return [Integer]
4056
+ #
4057
+ class ListDatasetLabelsRequest < Struct.new(
4058
+ :dataset_arn,
4059
+ :next_token,
4060
+ :max_results)
4061
+ SENSITIVE = []
4062
+ include Aws::Structure
4063
+ end
4064
+
4065
+ # @!attribute [rw] dataset_label_descriptions
4066
+ # A list of the labels in the dataset.
4067
+ # @return [Array<Types::DatasetLabelDescription>]
4068
+ #
4069
+ # @!attribute [rw] next_token
4070
+ # If the previous response was incomplete (because there is more
4071
+ # results to retrieve), Amazon Rekognition Custom Labels returns a
4072
+ # pagination token in the response. You can use this pagination token
4073
+ # to retrieve the next set of results.
4074
+ # @return [String]
4075
+ #
4076
+ class ListDatasetLabelsResponse < Struct.new(
4077
+ :dataset_label_descriptions,
4078
+ :next_token)
4079
+ SENSITIVE = []
4080
+ include Aws::Structure
4081
+ end
4082
+
3552
4083
  # @note When making an API call, you may pass ListFacesRequest
3553
4084
  # data as a hash:
3554
4085
  #
@@ -3944,7 +4475,8 @@ module Aws::Rekognition
3944
4475
  include Aws::Structure
3945
4476
  end
3946
4477
 
3947
- # A description of a Amazon Rekognition Custom Labels project.
4478
+ # A description of an Amazon Rekognition Custom Labels project. For more
4479
+ # information, see DescribeProjects.
3948
4480
  #
3949
4481
  # @!attribute [rw] project_arn
3950
4482
  # The Amazon Resource Name (ARN) of the project.
@@ -3959,15 +4491,21 @@ module Aws::Rekognition
3959
4491
  # The current status of the project.
3960
4492
  # @return [String]
3961
4493
  #
4494
+ # @!attribute [rw] datasets
4495
+ # Information about the training and test datasets in the project.
4496
+ # @return [Array<Types::DatasetMetadata>]
4497
+ #
3962
4498
  class ProjectDescription < Struct.new(
3963
4499
  :project_arn,
3964
4500
  :creation_timestamp,
3965
- :status)
4501
+ :status,
4502
+ :datasets)
3966
4503
  SENSITIVE = []
3967
4504
  include Aws::Structure
3968
4505
  end
3969
4506
 
3970
- # The description of a version of a model.
4507
+ # A description of a version of an Amazon Rekognition Custom Labels
4508
+ # model.
3971
4509
  #
3972
4510
  # @!attribute [rw] project_version_arn
3973
4511
  # The Amazon Resource Name (ARN) of the model version.
@@ -3991,9 +4529,9 @@ module Aws::Rekognition
3991
4529
  # @return [String]
3992
4530
  #
3993
4531
  # @!attribute [rw] billable_training_time_in_seconds
3994
- # The duration, in seconds, that the model version has been billed for
3995
- # training. This value is only returned if the model version has been
3996
- # successfully trained.
4532
+ # The duration, in seconds, that you were billed for a successful
4533
+ # training of the model version. This value is only returned if the
4534
+ # model version has been successfully trained.
3997
4535
  # @return [Integer]
3998
4536
  #
3999
4537
  # @!attribute [rw] training_end_timestamp
@@ -4024,8 +4562,8 @@ module Aws::Rekognition
4024
4562
  # @return [Types::GroundTruthManifest]
4025
4563
  #
4026
4564
  # @!attribute [rw] kms_key_id
4027
- # The identifer for the AWS Key Management Service (AWS KMS) customer
4028
- # master key that was used to encrypt the model during training.
4565
+ # The identifer for the AWS Key Management Service key (AWS KMS key)
4566
+ # that was used to encrypt the model during training.
4029
4567
  # @return [String]
4030
4568
  #
4031
4569
  class ProjectVersionDescription < Struct.new(
@@ -5747,8 +6285,8 @@ module Aws::Rekognition
5747
6285
  end
5748
6286
 
5749
6287
  # The dataset used for testing. Optionally, if `AutoCreate` is set,
5750
- # Amazon Rekognition Custom Labels creates a testing dataset using an
5751
- # 80/20 split of the training dataset.
6288
+ # Amazon Rekognition Custom Labels uses the training dataset to create a
6289
+ # test dataset with a temporary split of the training dataset.
5752
6290
  #
5753
6291
  # @note When making an API call, you may pass TestingData
5754
6292
  # data as a hash:
@@ -5773,8 +6311,10 @@ module Aws::Rekognition
5773
6311
  # @return [Array<Types::Asset>]
5774
6312
  #
5775
6313
  # @!attribute [rw] auto_create
5776
- # If specified, Amazon Rekognition Custom Labels creates a testing
5777
- # dataset with an 80/20 split of the training dataset.
6314
+ # If specified, Amazon Rekognition Custom Labels temporarily splits
6315
+ # the training dataset (80%) to create a test dataset (20%) for the
6316
+ # training job. After training completes, the test dataset is not
6317
+ # stored and the training dataset reverts to its previous size.
5778
6318
  # @return [Boolean]
5779
6319
  #
5780
6320
  class TestingData < Struct.new(
@@ -6006,12 +6546,40 @@ module Aws::Rekognition
6006
6546
 
6007
6547
  class UntagResourceResponse < Aws::EmptyStructure; end
6008
6548
 
6549
+ # @note When making an API call, you may pass UpdateDatasetEntriesRequest
6550
+ # data as a hash:
6551
+ #
6552
+ # {
6553
+ # dataset_arn: "DatasetArn", # required
6554
+ # changes: { # required
6555
+ # ground_truth: "data", # required
6556
+ # },
6557
+ # }
6558
+ #
6559
+ # @!attribute [rw] dataset_arn
6560
+ # The Amazon Resource Name (ARN) of the dataset that you want to
6561
+ # update.
6562
+ # @return [String]
6563
+ #
6564
+ # @!attribute [rw] changes
6565
+ # The changes that you want to make to the dataset.
6566
+ # @return [Types::DatasetChanges]
6567
+ #
6568
+ class UpdateDatasetEntriesRequest < Struct.new(
6569
+ :dataset_arn,
6570
+ :changes)
6571
+ SENSITIVE = []
6572
+ include Aws::Structure
6573
+ end
6574
+
6575
+ class UpdateDatasetEntriesResponse < Aws::EmptyStructure; end
6576
+
6009
6577
  # Contains the Amazon S3 bucket location of the validation data for a
6010
6578
  # model training job.
6011
6579
  #
6012
6580
  # The validation data includes error information for individual JSON
6013
- # lines in the dataset. For more information, see Debugging a Failed
6014
- # Model Training in the Amazon Rekognition Custom Labels Developer
6581
+ # Lines in the dataset. For more information, see *Debugging a Failed
6582
+ # Model Training* in the Amazon Rekognition Custom Labels Developer
6015
6583
  # Guide.
6016
6584
  #
6017
6585
  # You get the `ValidationData` object for the training dataset