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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rekognition/client.rb +469 -30
- data/lib/aws-sdk-rekognition/client_api.rb +272 -2
- data/lib/aws-sdk-rekognition/types.rb +600 -32
- data/lib/aws-sdk-rekognition.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 440755ea7d56cb5409d37fa7ced906589bc7f2f433a19297cbc22e62480a44a4
|
4
|
+
data.tar.gz: 16e01b60cd9f19bb22cee1878ee3bd71a08d58c1fd589fb7891bc07afe595d22
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c36642a1e693bfe4669aa8cbebc57c36147fc69bffd024e84addcbe0cfaa6fead98e7ba14be9bd796e69b7abbfa379362b4417e90a66ca8f55678ea7527acff5
|
7
|
+
data.tar.gz: 41ffd835d1a58658792bfe63d710e2dae64148d267d9864480a42f12672f191568c95c70962d3df805e36d679f3b8f1e2a3ee22a565ad06bb2c6607654a5b7d5
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.59.0
|
@@ -652,9 +652,84 @@ module Aws::Rekognition
|
|
652
652
|
req.send_request(options)
|
653
653
|
end
|
654
654
|
|
655
|
+
# Creates a new Amazon Rekognition Custom Labels dataset. You can create
|
656
|
+
# a dataset by using an Amazon Sagemaker format manifest file or by
|
657
|
+
# copying an existing Amazon Rekognition Custom Labels dataset.
|
658
|
+
#
|
659
|
+
# To create a training dataset for a project, specify `train` for the
|
660
|
+
# value of `DatasetType`. To create the test dataset for a project,
|
661
|
+
# specify `test` for the value of `DatasetType`.
|
662
|
+
#
|
663
|
+
# The response from `CreateDataset` is the Amazon Resource Name (ARN)
|
664
|
+
# for the dataset. Creating a dataset takes a while to complete. Use
|
665
|
+
# DescribeDataset to check the current status. The dataset created
|
666
|
+
# successfully if the value of `Status` is `CREATE_COMPLETE`.
|
667
|
+
#
|
668
|
+
# To check if any non-terminal errors occurred, call ListDatasetEntries
|
669
|
+
# and check for the presence of `errors` lists in the JSON Lines.
|
670
|
+
#
|
671
|
+
# Dataset creation fails if a terminal error occurs (`Status` =
|
672
|
+
# `CREATE_FAILED`). Currently, you can't access the terminal error
|
673
|
+
# information.
|
674
|
+
#
|
675
|
+
# For more information, see Creating dataset in the *Amazon Rekognition
|
676
|
+
# Custom Labels Developer Guide*.
|
677
|
+
#
|
678
|
+
# This operation requires permissions to perform the
|
679
|
+
# `rekognition:CreateDataset` action. If you want to copy an existing
|
680
|
+
# dataset, you also require permission to perform the
|
681
|
+
# `rekognition:ListDatasetEntries` action.
|
682
|
+
#
|
683
|
+
# @option params [Types::DatasetSource] :dataset_source
|
684
|
+
# The source files for the dataset. You can specify the ARN of an
|
685
|
+
# existing dataset or specify the Amazon S3 bucket location of an Amazon
|
686
|
+
# Sagemaker format manifest file. If you don't specify `datasetSource`,
|
687
|
+
# an empty dataset is created. To add labeled images to the dataset, You
|
688
|
+
# can use the console or call UpdateDatasetEntries.
|
689
|
+
#
|
690
|
+
# @option params [required, String] :dataset_type
|
691
|
+
# The type of the dataset. Specify `train` to create a training dataset.
|
692
|
+
# Specify `test` to create a test dataset.
|
693
|
+
#
|
694
|
+
# @option params [required, String] :project_arn
|
695
|
+
# The ARN of the Amazon Rekognition Custom Labels project to which you
|
696
|
+
# want to asssign the dataset.
|
697
|
+
#
|
698
|
+
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
699
|
+
#
|
700
|
+
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
701
|
+
#
|
702
|
+
# @example Request syntax with placeholder values
|
703
|
+
#
|
704
|
+
# resp = client.create_dataset({
|
705
|
+
# dataset_source: {
|
706
|
+
# ground_truth_manifest: {
|
707
|
+
# s3_object: {
|
708
|
+
# bucket: "S3Bucket",
|
709
|
+
# name: "S3ObjectName",
|
710
|
+
# version: "S3ObjectVersion",
|
711
|
+
# },
|
712
|
+
# },
|
713
|
+
# dataset_arn: "DatasetArn",
|
714
|
+
# },
|
715
|
+
# dataset_type: "TRAIN", # required, accepts TRAIN, TEST
|
716
|
+
# project_arn: "ProjectArn", # required
|
717
|
+
# })
|
718
|
+
#
|
719
|
+
# @example Response structure
|
720
|
+
#
|
721
|
+
# resp.dataset_arn #=> String
|
722
|
+
#
|
723
|
+
# @overload create_dataset(params = {})
|
724
|
+
# @param [Hash] params ({})
|
725
|
+
def create_dataset(params = {}, options = {})
|
726
|
+
req = build_request(:create_dataset, params)
|
727
|
+
req.send_request(options)
|
728
|
+
end
|
729
|
+
|
655
730
|
# Creates a new Amazon Rekognition Custom Labels project. A project is a
|
656
|
-
#
|
657
|
-
#
|
731
|
+
# group of resources (datasets, model versions) that you use to create
|
732
|
+
# and manage Amazon Rekognition Custom Labels models.
|
658
733
|
#
|
659
734
|
# This operation requires permissions to perform the
|
660
735
|
# `rekognition:CreateProject` action.
|
@@ -684,16 +759,40 @@ module Aws::Rekognition
|
|
684
759
|
end
|
685
760
|
|
686
761
|
# Creates a new version of a model and begins training. Models are
|
687
|
-
# managed as part of an Amazon Rekognition Custom Labels project.
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
762
|
+
# managed as part of an Amazon Rekognition Custom Labels project. The
|
763
|
+
# response from `CreateProjectVersion` is an Amazon Resource Name (ARN)
|
764
|
+
# for the version of the model.
|
765
|
+
#
|
766
|
+
# Training uses the training and test datasets associated with the
|
767
|
+
# project. For more information, see Creating training and test dataset
|
768
|
+
# in the *Amazon Rekognition Custom Labels Developer Guide*.
|
769
|
+
#
|
770
|
+
# <note markdown="1"> You can train a modelin a project that doesn't have associated
|
771
|
+
# datasets by specifying manifest files in the `TrainingData` and
|
772
|
+
# `TestingData` fields.
|
773
|
+
#
|
774
|
+
# If you open the console after training a model with manifest files,
|
775
|
+
# Amazon Rekognition Custom Labels creates the datasets for you using
|
776
|
+
# the most recent manifest files. You can no longer train a model
|
777
|
+
# version for the project by specifying manifest files.
|
778
|
+
#
|
779
|
+
# Instead of training with a project without associated datasets, we
|
780
|
+
# recommend that you use the manifest files to create training and test
|
781
|
+
# datasets for the project.
|
782
|
+
#
|
783
|
+
# </note>
|
691
784
|
#
|
692
785
|
# Training takes a while to complete. You can get the current status by
|
693
|
-
# calling DescribeProjectVersions.
|
786
|
+
# calling DescribeProjectVersions. Training completed successfully if
|
787
|
+
# the value of the `Status` field is `TRAINING_COMPLETED`.
|
788
|
+
#
|
789
|
+
# If training fails, see Debugging a failed model training in the
|
790
|
+
# *Amazon Rekognition Custom Labels* developer guide.
|
694
791
|
#
|
695
792
|
# Once training has successfully completed, call DescribeProjectVersions
|
696
|
-
# to get the training results and evaluate the model.
|
793
|
+
# to get the training results and evaluate the model. For more
|
794
|
+
# information, see Improving a trained Amazon Rekognition Custom Labels
|
795
|
+
# model in the *Amazon Rekognition Custom Labels* developers guide.
|
697
796
|
#
|
698
797
|
# After evaluating the model, you start the model by calling
|
699
798
|
# StartProjectVersion.
|
@@ -713,26 +812,30 @@ module Aws::Rekognition
|
|
713
812
|
# bucket can be in any AWS account as long as the caller has
|
714
813
|
# `s3:PutObject` permissions on the S3 bucket.
|
715
814
|
#
|
716
|
-
# @option params [
|
717
|
-
#
|
815
|
+
# @option params [Types::TrainingData] :training_data
|
816
|
+
# Specifies an external manifest that the services uses to train the
|
817
|
+
# model. If you specify `TrainingData` you must also specify
|
818
|
+
# `TestingData`. The project must not have any associated datasets.
|
718
819
|
#
|
719
|
-
# @option params [
|
720
|
-
#
|
820
|
+
# @option params [Types::TestingData] :testing_data
|
821
|
+
# Specifies an external manifest that the service uses to test the
|
822
|
+
# model. If you specify `TestingData` you must also specify
|
823
|
+
# `TrainingData`. The project must not have any associated datasets.
|
721
824
|
#
|
722
825
|
# @option params [Hash<String,String>] :tags
|
723
826
|
# A set of tags (key-value pairs) that you want to attach to the model.
|
724
827
|
#
|
725
828
|
# @option params [String] :kms_key_id
|
726
|
-
# The identifier for your AWS Key Management Service (AWS KMS)
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
829
|
+
# The identifier for your AWS Key Management Service key (AWS KMS key).
|
830
|
+
# You can supply the Amazon Resource Name (ARN) of your KMS key, the ID
|
831
|
+
# of your KMS key, an alias for your KMS key, or an alias ARN. The key
|
832
|
+
# is used to encrypt training and test images copied into the service
|
833
|
+
# for model training. Your source images are unaffected. The key is also
|
834
|
+
# used to encrypt training results and manifest files written to the
|
835
|
+
# output Amazon S3 bucket (`OutputConfig`).
|
733
836
|
#
|
734
|
-
# If you choose to use your own
|
735
|
-
# on the
|
837
|
+
# If you choose to use your own KMS key, you need the following
|
838
|
+
# permissions on the KMS key.
|
736
839
|
#
|
737
840
|
# * kms:CreateGrant
|
738
841
|
#
|
@@ -758,7 +861,7 @@ module Aws::Rekognition
|
|
758
861
|
# s3_bucket: "S3Bucket",
|
759
862
|
# s3_key_prefix: "S3KeyPrefix",
|
760
863
|
# },
|
761
|
-
# training_data: {
|
864
|
+
# training_data: {
|
762
865
|
# assets: [
|
763
866
|
# {
|
764
867
|
# ground_truth_manifest: {
|
@@ -771,7 +874,7 @@ module Aws::Rekognition
|
|
771
874
|
# },
|
772
875
|
# ],
|
773
876
|
# },
|
774
|
-
# testing_data: {
|
877
|
+
# testing_data: {
|
775
878
|
# assets: [
|
776
879
|
# {
|
777
880
|
# ground_truth_manifest: {
|
@@ -940,6 +1043,38 @@ module Aws::Rekognition
|
|
940
1043
|
req.send_request(options)
|
941
1044
|
end
|
942
1045
|
|
1046
|
+
# Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting
|
1047
|
+
# a dataset might take while. Use DescribeDataset to check the current
|
1048
|
+
# status. The dataset is still deleting if the value of `Status` is
|
1049
|
+
# `DELETE_IN_PROGRESS`. If you try to access the dataset after it is
|
1050
|
+
# deleted, you get a `ResourceNotFoundException` exception.
|
1051
|
+
#
|
1052
|
+
# You can't delete a dataset while it is creating (`Status` =
|
1053
|
+
# `CREATE_IN_PROGRESS`) or if the dataset is updating (`Status` =
|
1054
|
+
# `UPDATE_IN_PROGRESS`).
|
1055
|
+
#
|
1056
|
+
# This operation requires permissions to perform the
|
1057
|
+
# `rekognition:DeleteDataset` action.
|
1058
|
+
#
|
1059
|
+
# @option params [required, String] :dataset_arn
|
1060
|
+
# The ARN of the Amazon Rekognition Custom Labels dataset that you want
|
1061
|
+
# to delete.
|
1062
|
+
#
|
1063
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1064
|
+
#
|
1065
|
+
# @example Request syntax with placeholder values
|
1066
|
+
#
|
1067
|
+
# resp = client.delete_dataset({
|
1068
|
+
# dataset_arn: "DatasetArn", # required
|
1069
|
+
# })
|
1070
|
+
#
|
1071
|
+
# @overload delete_dataset(params = {})
|
1072
|
+
# @param [Hash] params ({})
|
1073
|
+
def delete_dataset(params = {}, options = {})
|
1074
|
+
req = build_request(:delete_dataset, params)
|
1075
|
+
req.send_request(options)
|
1076
|
+
end
|
1077
|
+
|
943
1078
|
# Deletes faces from a collection. You specify a collection ID and an
|
944
1079
|
# array of face IDs to remove from the collection.
|
945
1080
|
#
|
@@ -998,6 +1133,10 @@ module Aws::Rekognition
|
|
998
1133
|
# project you must first delete all models associated with the project.
|
999
1134
|
# To delete a model, see DeleteProjectVersion.
|
1000
1135
|
#
|
1136
|
+
# `DeleteProject` is an asynchronous operation. To check if the project
|
1137
|
+
# is deleted, call DescribeProjects. The project is deleted when the
|
1138
|
+
# project no longer appears in the response.
|
1139
|
+
#
|
1001
1140
|
# This operation requires permissions to perform the
|
1002
1141
|
# `rekognition:DeleteProject` action.
|
1003
1142
|
#
|
@@ -1122,10 +1261,50 @@ module Aws::Rekognition
|
|
1122
1261
|
req.send_request(options)
|
1123
1262
|
end
|
1124
1263
|
|
1125
|
-
#
|
1126
|
-
#
|
1264
|
+
# Describes an Amazon Rekognition Custom Labels dataset. You can get
|
1265
|
+
# information such as the current status of a dataset and statistics
|
1266
|
+
# about the images and labels in a dataset.
|
1267
|
+
#
|
1268
|
+
# This operation requires permissions to perform the
|
1269
|
+
# `rekognition:DescribeDataset` action.
|
1270
|
+
#
|
1271
|
+
# @option params [required, String] :dataset_arn
|
1272
|
+
# The Amazon Resource Name (ARN) of the dataset that you want to
|
1273
|
+
# describe.
|
1274
|
+
#
|
1275
|
+
# @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
|
+
#
|
1277
|
+
# * {Types::DescribeDatasetResponse#dataset_description #dataset_description} => Types::DatasetDescription
|
1278
|
+
#
|
1279
|
+
# @example Request syntax with placeholder values
|
1280
|
+
#
|
1281
|
+
# resp = client.describe_dataset({
|
1282
|
+
# dataset_arn: "DatasetArn", # required
|
1283
|
+
# })
|
1284
|
+
#
|
1285
|
+
# @example Response structure
|
1286
|
+
#
|
1287
|
+
# resp.dataset_description.creation_timestamp #=> Time
|
1288
|
+
# resp.dataset_description.last_updated_timestamp #=> Time
|
1289
|
+
# resp.dataset_description.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "DELETE_IN_PROGRESS"
|
1290
|
+
# resp.dataset_description.status_message #=> String
|
1291
|
+
# resp.dataset_description.status_message_code #=> String, one of "SUCCESS", "SERVICE_ERROR", "CLIENT_ERROR"
|
1292
|
+
# resp.dataset_description.dataset_stats.labeled_entries #=> Integer
|
1293
|
+
# resp.dataset_description.dataset_stats.total_entries #=> Integer
|
1294
|
+
# resp.dataset_description.dataset_stats.total_labels #=> Integer
|
1295
|
+
# resp.dataset_description.dataset_stats.error_entries #=> Integer
|
1296
|
+
#
|
1297
|
+
# @overload describe_dataset(params = {})
|
1298
|
+
# @param [Hash] params ({})
|
1299
|
+
def describe_dataset(params = {}, options = {})
|
1300
|
+
req = build_request(:describe_dataset, params)
|
1301
|
+
req.send_request(options)
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Lists and describes the versions of a model in an Amazon Rekognition
|
1305
|
+
# Custom Labels project. You can specify up to 10 model versions in
|
1127
1306
|
# `ProjectVersionArns`. If you don't specify a value, descriptions for
|
1128
|
-
# all
|
1307
|
+
# all model versions in the project are returned.
|
1129
1308
|
#
|
1130
1309
|
# This operation requires permissions to perform the
|
1131
1310
|
# `rekognition:DescribeProjectVersions` action.
|
@@ -1232,8 +1411,7 @@ module Aws::Rekognition
|
|
1232
1411
|
req.send_request(options)
|
1233
1412
|
end
|
1234
1413
|
|
1235
|
-
#
|
1236
|
-
# projects.
|
1414
|
+
# Gets information about your Amazon Rekognition Custom Labels projects.
|
1237
1415
|
#
|
1238
1416
|
# This operation requires permissions to perform the
|
1239
1417
|
# `rekognition:DescribeProjects` action.
|
@@ -1250,6 +1428,11 @@ module Aws::Rekognition
|
|
1250
1428
|
# than 100, a ValidationException error occurs. The default value is
|
1251
1429
|
# 100.
|
1252
1430
|
#
|
1431
|
+
# @option params [Array<String>] :project_names
|
1432
|
+
# A list of the projects that you want Amazon Rekognition Custom Labels
|
1433
|
+
# to describe. If you don't specify a value, the response includes
|
1434
|
+
# descriptions for all the projects in your AWS account.
|
1435
|
+
#
|
1253
1436
|
# @return [Types::DescribeProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1254
1437
|
#
|
1255
1438
|
# * {Types::DescribeProjectsResponse#project_descriptions #project_descriptions} => Array<Types::ProjectDescription>
|
@@ -1262,6 +1445,7 @@ module Aws::Rekognition
|
|
1262
1445
|
# resp = client.describe_projects({
|
1263
1446
|
# next_token: "ExtendedPaginationToken",
|
1264
1447
|
# max_results: 1,
|
1448
|
+
# project_names: ["ProjectName"],
|
1265
1449
|
# })
|
1266
1450
|
#
|
1267
1451
|
# @example Response structure
|
@@ -1270,6 +1454,13 @@ module Aws::Rekognition
|
|
1270
1454
|
# resp.project_descriptions[0].project_arn #=> String
|
1271
1455
|
# resp.project_descriptions[0].creation_timestamp #=> Time
|
1272
1456
|
# resp.project_descriptions[0].status #=> String, one of "CREATING", "CREATED", "DELETING"
|
1457
|
+
# resp.project_descriptions[0].datasets #=> Array
|
1458
|
+
# resp.project_descriptions[0].datasets[0].creation_timestamp #=> Time
|
1459
|
+
# resp.project_descriptions[0].datasets[0].dataset_type #=> String, one of "TRAIN", "TEST"
|
1460
|
+
# resp.project_descriptions[0].datasets[0].dataset_arn #=> String
|
1461
|
+
# resp.project_descriptions[0].datasets[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "DELETE_IN_PROGRESS"
|
1462
|
+
# resp.project_descriptions[0].datasets[0].status_message #=> String
|
1463
|
+
# resp.project_descriptions[0].datasets[0].status_message_code #=> String, one of "SUCCESS", "SERVICE_ERROR", "CLIENT_ERROR"
|
1273
1464
|
# resp.next_token #=> String
|
1274
1465
|
#
|
1275
1466
|
# @overload describe_projects(params = {})
|
@@ -2118,6 +2309,50 @@ module Aws::Rekognition
|
|
2118
2309
|
req.send_request(options)
|
2119
2310
|
end
|
2120
2311
|
|
2312
|
+
# Distributes the entries (images) in a training dataset across the
|
2313
|
+
# training dataset and the test dataset for a project.
|
2314
|
+
# `DistributeDatasetEntries` moves 20% of the training dataset images to
|
2315
|
+
# the test dataset. An entry is a JSON Line that describes an image.
|
2316
|
+
#
|
2317
|
+
# You supply the Amazon Resource Names (ARN) of a project's training
|
2318
|
+
# dataset and test dataset. The training dataset must contain the images
|
2319
|
+
# that you want to split. The test dataset must be empty. The datasets
|
2320
|
+
# must belong to the same project. To create training and test datasets
|
2321
|
+
# for a project, call CreateDataset.
|
2322
|
+
#
|
2323
|
+
# Distributing a dataset takes a while to complete. To check the status
|
2324
|
+
# call `DescribeDataset`. The operation is complete when the `Status`
|
2325
|
+
# field for the training dataset and the test dataset is
|
2326
|
+
# `UPDATE_COMPLETE`. If the dataset split fails, the value of `Status`
|
2327
|
+
# is `UPDATE_FAILED`.
|
2328
|
+
#
|
2329
|
+
# This operation requires permissions to perform the
|
2330
|
+
# `rekognition:DistributeDatasetEntries` action.
|
2331
|
+
#
|
2332
|
+
# @option params [required, Array<Types::DistributeDataset>] :datasets
|
2333
|
+
# The ARNS for the training dataset and test dataset that you want to
|
2334
|
+
# use. The datasets must belong to the same project. The test dataset
|
2335
|
+
# must be empty.
|
2336
|
+
#
|
2337
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2338
|
+
#
|
2339
|
+
# @example Request syntax with placeholder values
|
2340
|
+
#
|
2341
|
+
# resp = client.distribute_dataset_entries({
|
2342
|
+
# datasets: [ # required
|
2343
|
+
# {
|
2344
|
+
# arn: "DatasetArn", # required
|
2345
|
+
# },
|
2346
|
+
# ],
|
2347
|
+
# })
|
2348
|
+
#
|
2349
|
+
# @overload distribute_dataset_entries(params = {})
|
2350
|
+
# @param [Hash] params ({})
|
2351
|
+
def distribute_dataset_entries(params = {}, options = {})
|
2352
|
+
req = build_request(:distribute_dataset_entries, params)
|
2353
|
+
req.send_request(options)
|
2354
|
+
end
|
2355
|
+
|
2121
2356
|
# Gets the name and additional information about a celebrity based on
|
2122
2357
|
# their Amazon Rekognition ID. The additional information is returned as
|
2123
2358
|
# an array of URLs. If there is no additional information about the
|
@@ -3657,6 +3892,155 @@ module Aws::Rekognition
|
|
3657
3892
|
req.send_request(options)
|
3658
3893
|
end
|
3659
3894
|
|
3895
|
+
# Lists the entries (images) within a dataset. An entry is a JSON Line
|
3896
|
+
# that contains the information for a single image, including the image
|
3897
|
+
# location, assigned labels, and object location bounding boxes. For
|
3898
|
+
# more information, see [Creating a manifest file][1].
|
3899
|
+
#
|
3900
|
+
# JSON Lines in the response include information about non-terminal
|
3901
|
+
# errors found in the dataset. Non terminal errors are reported in
|
3902
|
+
# `errors` lists within each JSON Line. The same information is reported
|
3903
|
+
# in the training and testing validation result manifests that Amazon
|
3904
|
+
# Rekognition Custom Labels creates during model training.
|
3905
|
+
#
|
3906
|
+
# You can filter the response in variety of ways, such as choosing which
|
3907
|
+
# labels to return and returning JSON Lines created after a specific
|
3908
|
+
# date.
|
3909
|
+
#
|
3910
|
+
# This operation requires permissions to perform the
|
3911
|
+
# `rekognition:ListDatasetEntries` action.
|
3912
|
+
#
|
3913
|
+
#
|
3914
|
+
#
|
3915
|
+
# [1]: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html
|
3916
|
+
#
|
3917
|
+
# @option params [required, String] :dataset_arn
|
3918
|
+
# The Amazon Resource Name (ARN) for the dataset that you want to use.
|
3919
|
+
#
|
3920
|
+
# @option params [Array<String>] :contains_labels
|
3921
|
+
# Specifies a label filter for the response. The response includes an
|
3922
|
+
# entry only if one or more of the labels in `ContainsLabels` exist in
|
3923
|
+
# the entry.
|
3924
|
+
#
|
3925
|
+
# @option params [Boolean] :labeled
|
3926
|
+
# Specify `true` to get only the JSON Lines where the image is labeled.
|
3927
|
+
# Specify `false` to get only the JSON Lines where the image isn't
|
3928
|
+
# labeled. If you don't specify `Labeled`, `ListDatasetEntries` returns
|
3929
|
+
# JSON Lines for labeled and unlabeled images.
|
3930
|
+
#
|
3931
|
+
# @option params [String] :source_ref_contains
|
3932
|
+
# If specified, `ListDatasetEntries` only returns JSON Lines where the
|
3933
|
+
# value of `SourceRefContains` is part of the `source-ref` field. The
|
3934
|
+
# `source-ref` field contains the Amazon S3 location of the image. You
|
3935
|
+
# can use `SouceRefContains` for tasks such as getting the JSON Line for
|
3936
|
+
# a single image, or gettting JSON Lines for all images within a
|
3937
|
+
# specific folder.
|
3938
|
+
#
|
3939
|
+
# @option params [Boolean] :has_errors
|
3940
|
+
# Specifies an error filter for the response. Specify `True` to only
|
3941
|
+
# include entries that have errors.
|
3942
|
+
#
|
3943
|
+
# @option params [String] :next_token
|
3944
|
+
# If the previous response was incomplete (because there is more results
|
3945
|
+
# to retrieve), Amazon Rekognition Custom Labels returns a pagination
|
3946
|
+
# token in the response. You can use this pagination token to retrieve
|
3947
|
+
# the next set of results.
|
3948
|
+
#
|
3949
|
+
# @option params [Integer] :max_results
|
3950
|
+
# The maximum number of results to return per paginated call. The
|
3951
|
+
# largest value you can specify is 100. If you specify a value greater
|
3952
|
+
# than 100, a ValidationException error occurs. The default value is
|
3953
|
+
# 100.
|
3954
|
+
#
|
3955
|
+
# @return [Types::ListDatasetEntriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3956
|
+
#
|
3957
|
+
# * {Types::ListDatasetEntriesResponse#dataset_entries #dataset_entries} => Array<String>
|
3958
|
+
# * {Types::ListDatasetEntriesResponse#next_token #next_token} => String
|
3959
|
+
#
|
3960
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3961
|
+
#
|
3962
|
+
# @example Request syntax with placeholder values
|
3963
|
+
#
|
3964
|
+
# resp = client.list_dataset_entries({
|
3965
|
+
# dataset_arn: "DatasetArn", # required
|
3966
|
+
# contains_labels: ["DatasetLabel"],
|
3967
|
+
# labeled: false,
|
3968
|
+
# source_ref_contains: "QueryString",
|
3969
|
+
# has_errors: false,
|
3970
|
+
# next_token: "ExtendedPaginationToken",
|
3971
|
+
# max_results: 1,
|
3972
|
+
# })
|
3973
|
+
#
|
3974
|
+
# @example Response structure
|
3975
|
+
#
|
3976
|
+
# resp.dataset_entries #=> Array
|
3977
|
+
# resp.dataset_entries[0] #=> String
|
3978
|
+
# resp.next_token #=> String
|
3979
|
+
#
|
3980
|
+
# @overload list_dataset_entries(params = {})
|
3981
|
+
# @param [Hash] params ({})
|
3982
|
+
def list_dataset_entries(params = {}, options = {})
|
3983
|
+
req = build_request(:list_dataset_entries, params)
|
3984
|
+
req.send_request(options)
|
3985
|
+
end
|
3986
|
+
|
3987
|
+
# Lists the labels in a dataset. Amazon Rekognition Custom Labels uses
|
3988
|
+
# labels to describe images. For more information, see [Labeling
|
3989
|
+
# images][1].
|
3990
|
+
#
|
3991
|
+
# Lists the labels in a dataset. Amazon Rekognition Custom Labels uses
|
3992
|
+
# labels to describe images. For more information, see Labeling images
|
3993
|
+
# in the *Amazon Rekognition Custom Labels Developer Guide*.
|
3994
|
+
#
|
3995
|
+
#
|
3996
|
+
#
|
3997
|
+
# [1]: https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html
|
3998
|
+
#
|
3999
|
+
# @option params [required, String] :dataset_arn
|
4000
|
+
# The Amazon Resource Name (ARN) of the dataset that you want to use.
|
4001
|
+
#
|
4002
|
+
# @option params [String] :next_token
|
4003
|
+
# If the previous response was incomplete (because there is more results
|
4004
|
+
# to retrieve), Amazon Rekognition Custom Labels returns a pagination
|
4005
|
+
# token in the response. You can use this pagination token to retrieve
|
4006
|
+
# the next set of results.
|
4007
|
+
#
|
4008
|
+
# @option params [Integer] :max_results
|
4009
|
+
# The maximum number of results to return per paginated call. The
|
4010
|
+
# largest value you can specify is 100. If you specify a value greater
|
4011
|
+
# than 100, a ValidationException error occurs. The default value is
|
4012
|
+
# 100.
|
4013
|
+
#
|
4014
|
+
# @return [Types::ListDatasetLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4015
|
+
#
|
4016
|
+
# * {Types::ListDatasetLabelsResponse#dataset_label_descriptions #dataset_label_descriptions} => Array<Types::DatasetLabelDescription>
|
4017
|
+
# * {Types::ListDatasetLabelsResponse#next_token #next_token} => String
|
4018
|
+
#
|
4019
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4020
|
+
#
|
4021
|
+
# @example Request syntax with placeholder values
|
4022
|
+
#
|
4023
|
+
# resp = client.list_dataset_labels({
|
4024
|
+
# dataset_arn: "DatasetArn", # required
|
4025
|
+
# next_token: "ExtendedPaginationToken",
|
4026
|
+
# max_results: 1,
|
4027
|
+
# })
|
4028
|
+
#
|
4029
|
+
# @example Response structure
|
4030
|
+
#
|
4031
|
+
# resp.dataset_label_descriptions #=> Array
|
4032
|
+
# resp.dataset_label_descriptions[0].label_name #=> String
|
4033
|
+
# resp.dataset_label_descriptions[0].label_stats.entry_count #=> Integer
|
4034
|
+
# resp.dataset_label_descriptions[0].label_stats.bounding_box_count #=> Integer
|
4035
|
+
# resp.next_token #=> String
|
4036
|
+
#
|
4037
|
+
# @overload list_dataset_labels(params = {})
|
4038
|
+
# @param [Hash] params ({})
|
4039
|
+
def list_dataset_labels(params = {}, options = {})
|
4040
|
+
req = build_request(:list_dataset_labels, params)
|
4041
|
+
req.send_request(options)
|
4042
|
+
end
|
4043
|
+
|
3660
4044
|
# Returns metadata for faces in the specified collection. This metadata
|
3661
4045
|
# includes information such as the bounding box coordinates, the
|
3662
4046
|
# confidence (that the bounding box contains a face), and face ID. For
|
@@ -3930,7 +4314,7 @@ module Aws::Rekognition
|
|
3930
4314
|
# Rekognition Developer Guide.
|
3931
4315
|
#
|
3932
4316
|
# `RecognizeCelebrities` returns the 64 largest faces in the image. It
|
3933
|
-
# lists recognized celebrities in the `CelebrityFaces` array and
|
4317
|
+
# lists the recognized celebrities in the `CelebrityFaces` array and any
|
3934
4318
|
# unrecognized faces in the `UnrecognizedFaces` array.
|
3935
4319
|
# `RecognizeCelebrities` doesn't return celebrities whose faces aren't
|
3936
4320
|
# among the largest 64 faces in the image.
|
@@ -5242,6 +5626,61 @@ module Aws::Rekognition
|
|
5242
5626
|
req.send_request(options)
|
5243
5627
|
end
|
5244
5628
|
|
5629
|
+
# Adds or updates one or more entries (images) in a dataset. An entry is
|
5630
|
+
# a JSON Line which contains the information for a single image,
|
5631
|
+
# including the image location, assigned labels, and object location
|
5632
|
+
# bounding boxes. For more information, see Image-Level labels in
|
5633
|
+
# manifest files and Object localization in manifest files in the
|
5634
|
+
# *Amazon Rekognition Custom Labels Developer Guide*.
|
5635
|
+
#
|
5636
|
+
# If the `source-ref` field in the JSON line references an existing
|
5637
|
+
# image, the existing image in the dataset is updated. If `source-ref`
|
5638
|
+
# field doesn't reference an existing image, the image is added as a
|
5639
|
+
# new image to the dataset.
|
5640
|
+
#
|
5641
|
+
# You specify the changes that you want to make in the `Changes` input
|
5642
|
+
# parameter. There isn't a limit to the number JSON Lines that you can
|
5643
|
+
# change, but the size of `Changes` must be less than 5MB.
|
5644
|
+
#
|
5645
|
+
# `UpdateDatasetEntries` returns immediatly, but the dataset update
|
5646
|
+
# might take a while to complete. Use DescribeDataset to check the
|
5647
|
+
# current status. The dataset updated successfully if the value of
|
5648
|
+
# `Status` is `UPDATE_COMPLETE`.
|
5649
|
+
#
|
5650
|
+
# To check if any non-terminal errors occured, call ListDatasetEntries
|
5651
|
+
# and check for the presence of `errors` lists in the JSON Lines.
|
5652
|
+
#
|
5653
|
+
# Dataset update fails if a terminal error occurs (`Status` =
|
5654
|
+
# `UPDATE_FAILED`). Currently, you can't access the terminal error
|
5655
|
+
# information from the Amazon Rekognition Custom Labels SDK.
|
5656
|
+
#
|
5657
|
+
# This operation requires permissions to perform the
|
5658
|
+
# `rekognition:UpdateDatasetEntries` action.
|
5659
|
+
#
|
5660
|
+
# @option params [required, String] :dataset_arn
|
5661
|
+
# The Amazon Resource Name (ARN) of the dataset that you want to update.
|
5662
|
+
#
|
5663
|
+
# @option params [required, Types::DatasetChanges] :changes
|
5664
|
+
# The changes that you want to make to the dataset.
|
5665
|
+
#
|
5666
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5667
|
+
#
|
5668
|
+
# @example Request syntax with placeholder values
|
5669
|
+
#
|
5670
|
+
# resp = client.update_dataset_entries({
|
5671
|
+
# dataset_arn: "DatasetArn", # required
|
5672
|
+
# changes: { # required
|
5673
|
+
# ground_truth: "data", # required
|
5674
|
+
# },
|
5675
|
+
# })
|
5676
|
+
#
|
5677
|
+
# @overload update_dataset_entries(params = {})
|
5678
|
+
# @param [Hash] params ({})
|
5679
|
+
def update_dataset_entries(params = {}, options = {})
|
5680
|
+
req = build_request(:update_dataset_entries, params)
|
5681
|
+
req.send_request(options)
|
5682
|
+
end
|
5683
|
+
|
5245
5684
|
# @!endgroup
|
5246
5685
|
|
5247
5686
|
# @param params ({})
|
@@ -5255,7 +5694,7 @@ module Aws::Rekognition
|
|
5255
5694
|
params: params,
|
5256
5695
|
config: config)
|
5257
5696
|
context[:gem_name] = 'aws-sdk-rekognition'
|
5258
|
-
context[:gem_version] = '1.
|
5697
|
+
context[:gem_version] = '1.59.0'
|
5259
5698
|
Seahorse::Client::Request.new(handlers, context)
|
5260
5699
|
end
|
5261
5700
|
|