aws-sdk-rekognition 1.85.0 → 1.87.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6e3dbf332c9b24f0604e584863e99f3824089858d3f324954bcf3708cafb68b4
4
- data.tar.gz: 03ddfbb468b08282a4a8f37dc5ea6ff774527a2c92a0e194a185cc90734af9ff
3
+ metadata.gz: 4ae37b2912fd788e9d6749b64bb13789ebe8b90d4d6b79fad47e09054db2da9f
4
+ data.tar.gz: 852341bc504a11798aaade72239c94b547548f840408b9b8c0edbb71da106637
5
5
  SHA512:
6
- metadata.gz: b46888d53dea098c1f7d362abd2df2a467766b9c4cde7db0a152982e6b070f1fde5d97b4c7453f7795576fce957467a8d97f3a2b9bf00ac06984ca9b32c7af06
7
- data.tar.gz: 109e9e986f3f03a4896bf31db75b7cbad07a248226f1bee115ea8e54e74695a3997ae7f3982bc29c792f4b9fe9233671e0802d3af035af5aa2d260d5ec6f2335
6
+ metadata.gz: 4fda36f647e6e94d4ee85d448315b442cf80e988e6d6e6e4ded54b13a045e72a2d68bd81446c92a9e567ae1c87008b3166f6111fc4b3529cd975b779e888cc59
7
+ data.tar.gz: 9fe35a6bc9ef1630ed3e2ab6be6ffc359881e538b498815afebc053b23392a79273b83d3ec40bfe910dc3950526e90249b55d1b148192389e145a12db33da975
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.87.0 (2023-09-27)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.86.0 (2023-08-07)
10
+ ------------------
11
+
12
+ * Feature - This release adds code snippets for Amazon Rekognition Custom Labels.
13
+
4
14
  1.85.0 (2023-07-11)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.85.0
1
+ 1.87.0
@@ -857,8 +857,7 @@ module Aws::Rekognition
857
857
  #
858
858
  # @example Example: CopyProjectVersion
859
859
  #
860
- # # This operation copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination
861
- # # project.
860
+ # # Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
862
861
  #
863
862
  # resp = client.copy_project_version({
864
863
  # destination_project_arn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765",
@@ -982,9 +981,9 @@ module Aws::Rekognition
982
981
  # a dataset by using an Amazon Sagemaker format manifest file or by
983
982
  # copying an existing Amazon Rekognition Custom Labels dataset.
984
983
  #
985
- # To create a training dataset for a project, specify `train` for the
984
+ # To create a training dataset for a project, specify `TRAIN` for the
986
985
  # value of `DatasetType`. To create the test dataset for a project,
987
- # specify `test` for the value of `DatasetType`.
986
+ # specify `TEST` for the value of `DatasetType`.
988
987
  #
989
988
  # The response from `CreateDataset` is the Amazon Resource Name (ARN)
990
989
  # for the dataset. Creating a dataset takes a while to complete. Use
@@ -1014,8 +1013,8 @@ module Aws::Rekognition
1014
1013
  # can use the console or call UpdateDatasetEntries.
1015
1014
  #
1016
1015
  # @option params [required, String] :dataset_type
1017
- # The type of the dataset. Specify `train` to create a training dataset.
1018
- # Specify `test` to create a test dataset.
1016
+ # The type of the dataset. Specify `TRAIN` to create a training dataset.
1017
+ # Specify `TEST` to create a test dataset.
1019
1018
  #
1020
1019
  # @option params [required, String] :project_arn
1021
1020
  # The ARN of the Amazon Rekognition Custom Labels project to which you
@@ -1025,6 +1024,29 @@ module Aws::Rekognition
1025
1024
  #
1026
1025
  # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
1027
1026
  #
1027
+ #
1028
+ # @example Example: To create an Amazon Rekognition Custom Labels dataset
1029
+ #
1030
+ # # Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.
1031
+ #
1032
+ # resp = client.create_dataset({
1033
+ # dataset_source: {
1034
+ # ground_truth_manifest: {
1035
+ # s3_object: {
1036
+ # bucket: "my-bucket",
1037
+ # name: "datasets/flowers_training/manifests/output/output.manifest",
1038
+ # },
1039
+ # },
1040
+ # },
1041
+ # dataset_type: "TRAIN",
1042
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
1043
+ # })
1044
+ #
1045
+ # resp.to_h outputs the following:
1046
+ # {
1047
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535",
1048
+ # }
1049
+ #
1028
1050
  # @example Request syntax with placeholder values
1029
1051
  #
1030
1052
  # resp = client.create_dataset({
@@ -1055,13 +1077,17 @@ module Aws::Rekognition
1055
1077
 
1056
1078
  # This API operation initiates a Face Liveness session. It returns a
1057
1079
  # `SessionId`, which you can use to start streaming Face Liveness video
1058
- # and get the results for a Face Liveness session. You can use the
1059
- # `OutputConfig` option in the Settings parameter to provide an Amazon
1060
- # S3 bucket location. The Amazon S3 bucket stores reference images and
1061
- # audit images. You can use `AuditImagesLimit` to limit the number of
1062
- # audit images returned. This number is between 0 and 4. By default, it
1063
- # is set to 0. The limit is best effort and based on the duration of the
1064
- # selfie-video.
1080
+ # and get the results for a Face Liveness session.
1081
+ #
1082
+ # You can use the `OutputConfig` option in the Settings parameter to
1083
+ # provide an Amazon S3 bucket location. The Amazon S3 bucket stores
1084
+ # reference images and audit images. If no Amazon S3 bucket is defined,
1085
+ # raw bytes are sent instead.
1086
+ #
1087
+ # You can use `AuditImagesLimit` to limit the number of audit images
1088
+ # returned when `GetFaceLivenessSessionResults` is called. This number
1089
+ # is between 0 and 4. By default, it is set to 0. The limit is best
1090
+ # effort and based on the duration of the selfie-video.
1065
1091
  #
1066
1092
  # @option params [String] :kms_key_id
1067
1093
  # The identifier for your AWS Key Management Service key (AWS KMS key).
@@ -1121,6 +1147,20 @@ module Aws::Rekognition
1121
1147
  #
1122
1148
  # * {Types::CreateProjectResponse#project_arn #project_arn} => String
1123
1149
  #
1150
+ #
1151
+ # @example Example: To create an Amazon Rekognition Custom Labels project
1152
+ #
1153
+ # # Creates an Amazon Rekognition Custom Labels project.
1154
+ #
1155
+ # resp = client.create_project({
1156
+ # project_name: "my-project",
1157
+ # })
1158
+ #
1159
+ # resp.to_h outputs the following:
1160
+ # {
1161
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285",
1162
+ # }
1163
+ #
1124
1164
  # @example Request syntax with placeholder values
1125
1165
  #
1126
1166
  # resp = client.create_project({
@@ -1232,6 +1272,25 @@ module Aws::Rekognition
1232
1272
  #
1233
1273
  # * {Types::CreateProjectVersionResponse#project_version_arn #project_version_arn} => String
1234
1274
  #
1275
+ #
1276
+ # @example Example: To train an Amazon Rekognition Custom Labels model
1277
+ #
1278
+ # # Trains a version of an Amazon Rekognition Custom Labels model.
1279
+ #
1280
+ # resp = client.create_project_version({
1281
+ # output_config: {
1282
+ # s3_bucket: "output_bucket",
1283
+ # s3_key_prefix: "output_folder",
1284
+ # },
1285
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
1286
+ # version_name: "1",
1287
+ # })
1288
+ #
1289
+ # resp.to_h outputs the following:
1290
+ # {
1291
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
1292
+ # }
1293
+ #
1235
1294
  # @example Request syntax with placeholder values
1236
1295
  #
1237
1296
  # resp = client.create_project_version({
@@ -1596,6 +1655,19 @@ module Aws::Rekognition
1596
1655
  #
1597
1656
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1598
1657
  #
1658
+ #
1659
+ # @example Example: To delete an Amazon Rekognition Custom Labels dataset
1660
+ #
1661
+ # # Deletes an Amazon Rekognition Custom Labels dataset.
1662
+ #
1663
+ # resp = client.delete_dataset({
1664
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321",
1665
+ # })
1666
+ #
1667
+ # resp.to_h outputs the following:
1668
+ # {
1669
+ # }
1670
+ #
1599
1671
  # @example Request syntax with placeholder values
1600
1672
  #
1601
1673
  # resp = client.delete_dataset({
@@ -1689,6 +1761,20 @@ module Aws::Rekognition
1689
1761
  #
1690
1762
  # * {Types::DeleteProjectResponse#status #status} => String
1691
1763
  #
1764
+ #
1765
+ # @example Example: To delete an Amazon Rekognition Custom Labels project
1766
+ #
1767
+ # # Deletes an Amazon Rekognition Custom Labels projects.
1768
+ #
1769
+ # resp = client.delete_project({
1770
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285",
1771
+ # })
1772
+ #
1773
+ # resp.to_h outputs the following:
1774
+ # {
1775
+ # status: "DELETING",
1776
+ # }
1777
+ #
1692
1778
  # @example Request syntax with placeholder values
1693
1779
  #
1694
1780
  # resp = client.delete_project({
@@ -1775,6 +1861,20 @@ module Aws::Rekognition
1775
1861
  #
1776
1862
  # * {Types::DeleteProjectVersionResponse#status #status} => String
1777
1863
  #
1864
+ #
1865
+ # @example Example: To delete an Amazon Rekognition Custom Labels model
1866
+ #
1867
+ # # Deletes a version of an Amazon Rekognition Custom Labels model.
1868
+ #
1869
+ # resp = client.delete_project_version({
1870
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
1871
+ # })
1872
+ #
1873
+ # resp.to_h outputs the following:
1874
+ # {
1875
+ # status: "DELETING",
1876
+ # }
1877
+ #
1778
1878
  # @example Request syntax with placeholder values
1779
1879
  #
1780
1880
  # resp = client.delete_project_version({
@@ -1922,6 +2022,32 @@ module Aws::Rekognition
1922
2022
  #
1923
2023
  # * {Types::DescribeDatasetResponse#dataset_description #dataset_description} => Types::DatasetDescription
1924
2024
  #
2025
+ #
2026
+ # @example Example: To describe an Amazon Rekognition Custom Labels dataset
2027
+ #
2028
+ # # Describes an Amazon Rekognition Custom Labels dataset.
2029
+ #
2030
+ # resp = client.describe_dataset({
2031
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535",
2032
+ # })
2033
+ #
2034
+ # resp.to_h outputs the following:
2035
+ # {
2036
+ # dataset_description: {
2037
+ # creation_timestamp: Time.parse("2023-07-27T09:41:24.738000-07:00"),
2038
+ # dataset_stats: {
2039
+ # error_entries: 0,
2040
+ # labeled_entries: 15,
2041
+ # total_entries: 15,
2042
+ # total_labels: 9,
2043
+ # },
2044
+ # last_updated_timestamp: Time.parse("2023-07-28T09:46:45.406000-07:00"),
2045
+ # status: "UPDATE_FAILED",
2046
+ # status_message: "The manifest file contains images from multiple S3 buckets.",
2047
+ # status_message_code: "CLIENT_ERROR",
2048
+ # },
2049
+ # }
2050
+ #
1925
2051
  # @example Request syntax with placeholder values
1926
2052
  #
1927
2053
  # resp = client.describe_dataset({
@@ -1987,6 +2113,110 @@ module Aws::Rekognition
1987
2113
  #
1988
2114
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1989
2115
  #
2116
+ #
2117
+ # @example Example: To describe an Amazon Rekognition Custom Labels model
2118
+ #
2119
+ # # Describes a version of an Amazon Rekognition Custom Labels model.
2120
+ #
2121
+ # resp = client.describe_project_versions({
2122
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
2123
+ # version_names: [
2124
+ # "1",
2125
+ # ],
2126
+ # })
2127
+ #
2128
+ # resp.to_h outputs the following:
2129
+ # {
2130
+ # next_token: "",
2131
+ # project_version_descriptions: [
2132
+ # {
2133
+ # billable_training_time_in_seconds: 1899,
2134
+ # creation_timestamp: Time.parse("2023-07-28T08:05:51.958000-07:00"),
2135
+ # evaluation_result: {
2136
+ # f1_score: 1,
2137
+ # summary: {
2138
+ # s3_object: {
2139
+ # bucket: "custom-labels-console-us-east-1-111111111",
2140
+ # name: "my-model-output/EvaluationResultSummary-my-project-1.json",
2141
+ # },
2142
+ # },
2143
+ # },
2144
+ # manifest_summary: {
2145
+ # s3_object: {
2146
+ # bucket: "custom-labels-console-us-east-1-111111111",
2147
+ # name: "my-model-output/ManifestSummary-my-project-1.json",
2148
+ # },
2149
+ # },
2150
+ # output_config: {
2151
+ # s3_bucket: "custom-labels-console-us-east-1-111111111",
2152
+ # s3_key_prefix: "my-model-output",
2153
+ # },
2154
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
2155
+ # status: "TRAINING_COMPLETED",
2156
+ # status_message: "The model is ready to run.",
2157
+ # testing_data_result: {
2158
+ # input: {
2159
+ # auto_create: false,
2160
+ # },
2161
+ # output: {
2162
+ # assets: [
2163
+ # {
2164
+ # ground_truth_manifest: {
2165
+ # s3_object: {
2166
+ # bucket: "custom-labels-console-us-east-1-111111111",
2167
+ # name: "my-model-output/TestingGroundTruth-my-project-1.json",
2168
+ # },
2169
+ # },
2170
+ # },
2171
+ # ],
2172
+ # auto_create: false,
2173
+ # },
2174
+ # validation: {
2175
+ # assets: [
2176
+ # {
2177
+ # ground_truth_manifest: {
2178
+ # s3_object: {
2179
+ # bucket: "custom-labels-console-us-east-1-111111111",
2180
+ # name: "my-model-output/TestingManifestWithValidation-my-project-1.json",
2181
+ # },
2182
+ # },
2183
+ # },
2184
+ # ],
2185
+ # },
2186
+ # },
2187
+ # training_data_result: {
2188
+ # input: {
2189
+ # },
2190
+ # output: {
2191
+ # assets: [
2192
+ # {
2193
+ # ground_truth_manifest: {
2194
+ # s3_object: {
2195
+ # bucket: "custom-labels-console-us-east-1-111111111",
2196
+ # name: "my-model-output/TrainingGroundTruth-my-project-1.json",
2197
+ # },
2198
+ # },
2199
+ # },
2200
+ # ],
2201
+ # },
2202
+ # validation: {
2203
+ # assets: [
2204
+ # {
2205
+ # ground_truth_manifest: {
2206
+ # s3_object: {
2207
+ # bucket: "custom-labels-console-us-east-1-111111111",
2208
+ # name: "my-model-output/TrainingManifestWithValidation-my-project-1.json",
2209
+ # },
2210
+ # },
2211
+ # },
2212
+ # ],
2213
+ # },
2214
+ # },
2215
+ # training_end_timestamp: Time.parse("2023-07-28T08:33:10.827000-07:00"),
2216
+ # },
2217
+ # ],
2218
+ # }
2219
+ #
1990
2220
  # @example Request syntax with placeholder values
1991
2221
  #
1992
2222
  # resp = client.describe_project_versions({
@@ -2088,6 +2318,46 @@ module Aws::Rekognition
2088
2318
  #
2089
2319
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2090
2320
  #
2321
+ #
2322
+ # @example Example: To describe an Amazon Rekognition Custom Labels project.
2323
+ #
2324
+ # # Describes an Amazon Rekognition Custom Labels projects.
2325
+ #
2326
+ # resp = client.describe_projects({
2327
+ # project_names: [
2328
+ # "my-project",
2329
+ # ],
2330
+ # })
2331
+ #
2332
+ # resp.to_h outputs the following:
2333
+ # {
2334
+ # project_descriptions: [
2335
+ # {
2336
+ # creation_timestamp: Time.parse("2022-06-13T15:16:00.634000-07:00"),
2337
+ # datasets: [
2338
+ # {
2339
+ # creation_timestamp: Time.parse("2022-06-13T15:17:34.620000-07:00"),
2340
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1655158654491",
2341
+ # dataset_type: "TEST",
2342
+ # status: "CREATE_COMPLETE",
2343
+ # status_message: "The dataset was successfully created from the manifest file.",
2344
+ # status_message_code: "SUCCESS",
2345
+ # },
2346
+ # {
2347
+ # creation_timestamp: Time.parse("2022-06-13T15:17:50.118000-07:00"),
2348
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1655158669954",
2349
+ # dataset_type: "TRAIN",
2350
+ # status: "CREATE_COMPLETE",
2351
+ # status_message: "The dataset was successfully created from the manifest file.",
2352
+ # status_message_code: "SUCCESS",
2353
+ # },
2354
+ # ],
2355
+ # project_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1655158560634",
2356
+ # status: "CREATED",
2357
+ # },
2358
+ # ],
2359
+ # }
2360
+ #
2091
2361
  # @example Request syntax with placeholder values
2092
2362
  #
2093
2363
  # resp = client.describe_projects({
@@ -2282,6 +2552,37 @@ module Aws::Rekognition
2282
2552
  #
2283
2553
  # * {Types::DetectCustomLabelsResponse#custom_labels #custom_labels} => Array<Types::CustomLabel>
2284
2554
  #
2555
+ #
2556
+ # @example Example: To detect custom labels in an image with an Amazon Rekognition Custom Labels model
2557
+ #
2558
+ # # Detects custom labels in an image with an Amazon Rekognition Custom Labels model
2559
+ #
2560
+ # resp = client.detect_custom_labels({
2561
+ # image: {
2562
+ # s3_object: {
2563
+ # bucket: "custom-labels-console-us-east-1-1111111111",
2564
+ # name: "assets/flowers_1_test_dataset/camellia4.jpg",
2565
+ # },
2566
+ # },
2567
+ # max_results: 100,
2568
+ # min_confidence: 50,
2569
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219",
2570
+ # })
2571
+ #
2572
+ # resp.to_h outputs the following:
2573
+ # {
2574
+ # custom_labels: [
2575
+ # {
2576
+ # confidence: 67.56399536132812,
2577
+ # name: "with_leaves",
2578
+ # },
2579
+ # {
2580
+ # confidence: 50.65699768066406,
2581
+ # name: "without_leaves",
2582
+ # },
2583
+ # ],
2584
+ # }
2585
+ #
2285
2586
  # @example Request syntax with placeholder values
2286
2587
  #
2287
2588
  # resp = client.detect_custom_labels({
@@ -2367,6 +2668,10 @@ module Aws::Rekognition
2367
2668
  # "AND" operator to determine which attributes to return (in this
2368
2669
  # case, all attributes).
2369
2670
  #
2671
+ # Note that while the FaceOccluded and EyeDirection attributes are
2672
+ # supported when using `DetectFaces`, they aren't supported when
2673
+ # analyzing videos with `StartFaceDetection` and `GetFaceDetection`.
2674
+ #
2370
2675
  # @return [Types::DetectFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2371
2676
  #
2372
2677
  # * {Types::DetectFacesResponse#face_details #face_details} => Array<Types::FaceDetail>
@@ -2533,10 +2838,11 @@ module Aws::Rekognition
2533
2838
  # and exclusive filters. For more information on filtering see
2534
2839
  # [Detecting Labels in an Image][1].
2535
2840
  #
2536
- # You can specify `MinConfidence` to control the confidence threshold
2537
- # for the labels returned. The default is 55%. You can also add the
2538
- # `MaxLabels` parameter to limit the number of labels returned. The
2539
- # default and upper limit is 1000 labels.
2841
+ # When getting labels, you can specify `MinConfidence` to control the
2842
+ # confidence threshold for the labels returned. The default is 55%. You
2843
+ # can also add the `MaxLabels` parameter to limit the number of labels
2844
+ # returned. The default and upper limit is 1000 labels. These arguments
2845
+ # are only valid when supplying GENERAL\_LABELS as a feature type.
2540
2846
  #
2541
2847
  # **Response Elements**
2542
2848
  #
@@ -2639,7 +2945,8 @@ module Aws::Rekognition
2639
2945
  # @option params [Integer] :max_labels
2640
2946
  # Maximum number of labels you want the service to return in the
2641
2947
  # response. The service returns the specified number of highest
2642
- # confidence labels.
2948
+ # confidence labels. Only valid when GENERAL\_LABELS is specified as a
2949
+ # feature type in the Feature input parameter.
2643
2950
  #
2644
2951
  # @option params [Float] :min_confidence
2645
2952
  # Specifies the minimum confidence level for the labels to return.
@@ -2647,7 +2954,9 @@ module Aws::Rekognition
2647
2954
  # than this specified value.
2648
2955
  #
2649
2956
  # If `MinConfidence` is not specified, the operation returns labels with
2650
- # a confidence values greater than or equal to 55 percent.
2957
+ # a confidence values greater than or equal to 55 percent. Only valid
2958
+ # when GENERAL\_LABELS is specified as a feature type in the Feature
2959
+ # input parameter.
2651
2960
  #
2652
2961
  # @option params [Array<String>] :features
2653
2962
  # A list of the types of analysis to perform. Specifying GENERAL\_LABELS
@@ -3231,6 +3540,26 @@ module Aws::Rekognition
3231
3540
  #
3232
3541
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3233
3542
  #
3543
+ #
3544
+ # @example Example: To distribute an Amazon Rekognition Custom Labels dataset
3545
+ #
3546
+ # # Distributes an Amazon Rekognition Custom Labels training dataset to a test dataset.
3547
+ #
3548
+ # resp = client.distribute_dataset_entries({
3549
+ # datasets: [
3550
+ # {
3551
+ # arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
3552
+ # },
3553
+ # {
3554
+ # arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/test/1690564858106",
3555
+ # },
3556
+ # ],
3557
+ # })
3558
+ #
3559
+ # resp.to_h outputs the following:
3560
+ # {
3561
+ # }
3562
+ #
3234
3563
  # @example Request syntax with placeholder values
3235
3564
  #
3236
3565
  # resp = client.distribute_dataset_entries({
@@ -3623,6 +3952,9 @@ module Aws::Rekognition
3623
3952
  # `GetFaceDetection` and populate the `NextToken` request parameter with
3624
3953
  # the token value returned from the previous call to `GetFaceDetection`.
3625
3954
  #
3955
+ # Note that for the `GetFaceDetection` operation, the returned values
3956
+ # for `FaceOccluded` and `EyeDirection` will always be "null".
3957
+ #
3626
3958
  # @option params [required, String] :job_id
3627
3959
  # Unique identifier for the face detection job. The `JobId` is returned
3628
3960
  # from `StartFaceDetection`.
@@ -3732,8 +4064,12 @@ module Aws::Rekognition
3732
4064
  # `CreateFaceLivenessSession`. Returns the corresponding Face Liveness
3733
4065
  # confidence score, a reference image that includes a face bounding box,
3734
4066
  # and audit images that also contain face bounding boxes. The Face
3735
- # Liveness confidence score ranges from 0 to 100. The reference image
3736
- # can optionally be returned.
4067
+ # Liveness confidence score ranges from 0 to 100.
4068
+ #
4069
+ # The number of audit images returned by `GetFaceLivenessSessionResults`
4070
+ # is defined by the `AuditImagesLimit` paramater when calling
4071
+ # `CreateFaceLivenessSession`. Reference images are always returned when
4072
+ # possible.
3737
4073
  #
3738
4074
  # @option params [required, String] :session_id
3739
4075
  # A unique 128-bit UUID. This is used to uniquely identify the session
@@ -4425,7 +4761,7 @@ module Aws::Rekognition
4425
4761
  # `StartLabelDetection`.
4426
4762
  #
4427
4763
  # `GetTextDetection` returns an array of detected text
4428
- # (`TextDetections`) sorted by the time the text was detected, up to 50
4764
+ # (`TextDetections`) sorted by the time the text was detected, up to 100
4429
4765
  # words per frame of video.
4430
4766
  #
4431
4767
  # Each element of the array includes the detected text, the precentage
@@ -5090,6 +5426,31 @@ module Aws::Rekognition
5090
5426
  #
5091
5427
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5092
5428
  #
5429
+ #
5430
+ # @example Example: To list the entries in an Amazon Rekognition Custom Labels dataset
5431
+ #
5432
+ # # Lists the JSON line entries in an Amazon Rekognition Custom Labels dataset.
5433
+ #
5434
+ # resp = client.list_dataset_entries({
5435
+ # contains_labels: [
5436
+ # "camellia",
5437
+ # ],
5438
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
5439
+ # has_errors: true,
5440
+ # labeled: true,
5441
+ # max_results: 100,
5442
+ # next_token: "",
5443
+ # source_ref_contains: "camellia4.jpg",
5444
+ # })
5445
+ #
5446
+ # resp.to_h outputs the following:
5447
+ # {
5448
+ # dataset_entries: [
5449
+ # "{\"source-ref\":\"s3://custom-labels-console-us-east-1-1111111111/assets/flowers_1_train_dataset/camellia4.jpg\",\"camellia\":1,\"camellia-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/camellia\",\"class-name\":\"camellia\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"cl-metadata\":{\"is_labeled\":true}}",
5450
+ # ],
5451
+ # next_token: "",
5452
+ # }
5453
+ #
5093
5454
  # @example Request syntax with placeholder values
5094
5455
  #
5095
5456
  # resp = client.list_dataset_entries({
@@ -5149,6 +5510,41 @@ module Aws::Rekognition
5149
5510
  #
5150
5511
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5151
5512
  #
5513
+ #
5514
+ # @example Example: To list the entries in an Amazon Rekognition Custom Labels dataset
5515
+ #
5516
+ # # Lists the JSON line entries in an Amazon Rekognition Custom Labels dataset.
5517
+ #
5518
+ # resp = client.list_dataset_labels({
5519
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
5520
+ # max_results: 100,
5521
+ # next_token: "",
5522
+ # })
5523
+ #
5524
+ # resp.to_h outputs the following:
5525
+ # {
5526
+ # dataset_label_descriptions: [
5527
+ # {
5528
+ # label_name: "camellia",
5529
+ # label_stats: {
5530
+ # entry_count: 1,
5531
+ # },
5532
+ # },
5533
+ # {
5534
+ # label_name: "with_leaves",
5535
+ # label_stats: {
5536
+ # entry_count: 2,
5537
+ # },
5538
+ # },
5539
+ # {
5540
+ # label_name: "mediterranean_spurge",
5541
+ # label_stats: {
5542
+ # entry_count: 1,
5543
+ # },
5544
+ # },
5545
+ # ],
5546
+ # }
5547
+ #
5152
5548
  # @example Request syntax with placeholder values
5153
5549
  #
5154
5550
  # resp = client.list_dataset_labels({
@@ -5194,10 +5590,12 @@ module Aws::Rekognition
5194
5590
  # Maximum number of faces to return.
5195
5591
  #
5196
5592
  # @option params [String] :user_id
5197
- # An array of user IDs to match when listing faces in a collection.
5593
+ # An array of user IDs to filter results with when listing faces in a
5594
+ # collection.
5198
5595
  #
5199
5596
  # @option params [Array<String>] :face_ids
5200
- # An array of face IDs to match when listing faces in a collection.
5597
+ # An array of face IDs to filter results with when listing faces in a
5598
+ # collection.
5201
5599
  #
5202
5600
  # @return [Types::ListFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5203
5601
  #
@@ -6958,6 +7356,22 @@ module Aws::Rekognition
6958
7356
  #
6959
7357
  # * {Types::StartProjectVersionResponse#status #status} => String
6960
7358
  #
7359
+ #
7360
+ # @example Example: To start an Amazon Rekognition Custom Labels model
7361
+ #
7362
+ # # Starts a version of an Amazon Rekognition Custom Labels model.
7363
+ #
7364
+ # resp = client.start_project_version({
7365
+ # max_inference_units: 1,
7366
+ # min_inference_units: 1,
7367
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
7368
+ # })
7369
+ #
7370
+ # resp.to_h outputs the following:
7371
+ # {
7372
+ # status: "STARTING",
7373
+ # }
7374
+ #
6961
7375
  # @example Request syntax with placeholder values
6962
7376
  #
6963
7377
  # resp = client.start_project_version({
@@ -7268,6 +7682,20 @@ module Aws::Rekognition
7268
7682
  #
7269
7683
  # * {Types::StopProjectVersionResponse#status #status} => String
7270
7684
  #
7685
+ #
7686
+ # @example Example: To stop an Amazon Rekognition Custom Labels model.
7687
+ #
7688
+ # # Stops a version of an Amazon Rekognition Custom Labels model.
7689
+ #
7690
+ # resp = client.stop_project_version({
7691
+ # project_version_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
7692
+ # })
7693
+ #
7694
+ # resp.to_h outputs the following:
7695
+ # {
7696
+ # status: "STOPPING",
7697
+ # }
7698
+ #
7271
7699
  # @example Request syntax with placeholder values
7272
7700
  #
7273
7701
  # resp = client.stop_project_version({
@@ -7410,6 +7838,22 @@ module Aws::Rekognition
7410
7838
  #
7411
7839
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
7412
7840
  #
7841
+ #
7842
+ # @example Example: To-add dataset entries to an Amazon Rekognition Custom Labels dataset
7843
+ #
7844
+ # # Adds dataset entries to an Amazon Rekognition Custom Labels dataset.
7845
+ #
7846
+ # resp = client.update_dataset_entries({
7847
+ # changes: {
7848
+ # ground_truth: "{\"source-ref\":\"s3://custom-labels-console-us-east-1-111111111/assets/flowers_1_test_dataset/mediterranean_spurge4.jpg\",\"mediterranean_spurge\":1,\"mediterranean_spurge-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/mediterranean_spurge\",\"class-name\":\"mediterranean_spurge\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"}}",
7849
+ # },
7850
+ # dataset_arn: "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
7851
+ # })
7852
+ #
7853
+ # resp.to_h outputs the following:
7854
+ # {
7855
+ # }
7856
+ #
7413
7857
  # @example Request syntax with placeholder values
7414
7858
  #
7415
7859
  # resp = client.update_dataset_entries({
@@ -7505,7 +7949,7 @@ module Aws::Rekognition
7505
7949
  params: params,
7506
7950
  config: config)
7507
7951
  context[:gem_name] = 'aws-sdk-rekognition'
7508
- context[:gem_version] = '1.85.0'
7952
+ context[:gem_version] = '1.87.0'
7509
7953
  Seahorse::Client::Request.new(handlers, context)
7510
7954
  end
7511
7955
 
@@ -869,8 +869,8 @@ module Aws::Rekognition
869
869
  # @return [Types::DatasetSource]
870
870
  #
871
871
  # @!attribute [rw] dataset_type
872
- # The type of the dataset. Specify `train` to create a training
873
- # dataset. Specify `test` to create a test dataset.
872
+ # The type of the dataset. Specify `TRAIN` to create a training
873
+ # dataset. Specify `TEST` to create a test dataset.
874
874
  # @return [String]
875
875
  #
876
876
  # @!attribute [rw] project_arn
@@ -1981,6 +1981,10 @@ module Aws::Rekognition
1981
1981
  # If you provide both, `["ALL", "DEFAULT"]`, the service uses a
1982
1982
  # logical "AND" operator to determine which attributes to return (in
1983
1983
  # this case, all attributes).
1984
+ #
1985
+ # Note that while the FaceOccluded and EyeDirection attributes are
1986
+ # supported when using `DetectFaces`, they aren't supported when
1987
+ # analyzing videos with `StartFaceDetection` and `GetFaceDetection`.
1984
1988
  # @return [Array<String>]
1985
1989
  #
1986
1990
  class DetectFacesRequest < Struct.new(
@@ -2151,7 +2155,8 @@ module Aws::Rekognition
2151
2155
  # @!attribute [rw] max_labels
2152
2156
  # Maximum number of labels you want the service to return in the
2153
2157
  # response. The service returns the specified number of highest
2154
- # confidence labels.
2158
+ # confidence labels. Only valid when GENERAL\_LABELS is specified as a
2159
+ # feature type in the Feature input parameter.
2155
2160
  # @return [Integer]
2156
2161
  #
2157
2162
  # @!attribute [rw] min_confidence
@@ -2160,7 +2165,9 @@ module Aws::Rekognition
2160
2165
  # than this specified value.
2161
2166
  #
2162
2167
  # If `MinConfidence` is not specified, the operation returns labels
2163
- # with a confidence values greater than or equal to 55 percent.
2168
+ # with a confidence values greater than or equal to 55 percent. Only
2169
+ # valid when GENERAL\_LABELS is specified as a feature type in the
2170
+ # Feature input parameter.
2164
2171
  # @return [Float]
2165
2172
  #
2166
2173
  # @!attribute [rw] features
@@ -3487,7 +3494,8 @@ module Aws::Rekognition
3487
3494
  # Base64-encoded bytes that return an image. If the
3488
3495
  # CreateFaceLivenessSession request included an OutputConfig argument,
3489
3496
  # the image will be uploaded to an S3Object specified in the output
3490
- # configuration.
3497
+ # configuration. If no Amazon S3 bucket is defined, raw bytes are sent
3498
+ # instead.
3491
3499
  # @return [Array<Types::AuditImage>]
3492
3500
  #
3493
3501
  class GetFaceLivenessSessionResultsResponse < Struct.new(
@@ -4811,11 +4819,13 @@ module Aws::Rekognition
4811
4819
  # @return [Integer]
4812
4820
  #
4813
4821
  # @!attribute [rw] user_id
4814
- # An array of user IDs to match when listing faces in a collection.
4822
+ # An array of user IDs to filter results with when listing faces in a
4823
+ # collection.
4815
4824
  # @return [String]
4816
4825
  #
4817
4826
  # @!attribute [rw] face_ids
4818
- # An array of face IDs to match when listing faces in a collection.
4827
+ # An array of face IDs to filter results with when listing faces in a
4828
+ # collection.
4819
4829
  # @return [Array<String>]
4820
4830
  #
4821
4831
  class ListFacesRequest < Struct.new(
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-rekognition/customizations'
53
53
  # @!group service
54
54
  module Aws::Rekognition
55
55
 
56
- GEM_VERSION = '1.85.0'
56
+ GEM_VERSION = '1.87.0'
57
57
 
58
58
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-rekognition
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.85.0
4
+ version: 1.87.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-11 00:00:00.000000000 Z
11
+ date: 2023-09-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.177.0
22
+ version: 3.184.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.177.0
32
+ version: 3.184.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement