aws-sdk-rekognition 1.87.0 → 1.89.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rekognition/client.rb +512 -93
- data/lib/aws-sdk-rekognition/client_api.rb +183 -0
- data/lib/aws-sdk-rekognition/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-rekognition/endpoints.rb +42 -0
- data/lib/aws-sdk-rekognition/errors.rb +11 -0
- data/lib/aws-sdk-rekognition/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-rekognition/types.rb +558 -83
- data/lib/aws-sdk-rekognition.rb +1 -1
- metadata +2 -2
@@ -776,6 +776,10 @@ module Aws::Rekognition
|
|
776
776
|
req.send_request(options)
|
777
777
|
end
|
778
778
|
|
779
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
780
|
+
#
|
781
|
+
# </note>
|
782
|
+
#
|
779
783
|
# Copies a version of an Amazon Rekognition Custom Labels model from a
|
780
784
|
# source project to a destination project. The source and destination
|
781
785
|
# projects can be in different AWS accounts but must be in the same AWS
|
@@ -794,7 +798,9 @@ module Aws::Rekognition
|
|
794
798
|
# If you are copying a model version to a project in the same AWS
|
795
799
|
# account, you don't need to create a project policy.
|
796
800
|
#
|
797
|
-
# <note markdown="1">
|
801
|
+
# <note markdown="1"> Copying project versions is supported only for Custom Labels models.
|
802
|
+
#
|
803
|
+
# To copy a model, the destination project, source project, and source
|
798
804
|
# model version must already exist.
|
799
805
|
#
|
800
806
|
# </note>
|
@@ -977,6 +983,10 @@ module Aws::Rekognition
|
|
977
983
|
req.send_request(options)
|
978
984
|
end
|
979
985
|
|
986
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
987
|
+
#
|
988
|
+
# </note>
|
989
|
+
#
|
980
990
|
# Creates a new Amazon Rekognition Custom Labels dataset. You can create
|
981
991
|
# a dataset by using an Amazon Sagemaker format manifest file or by
|
982
992
|
# copying an existing Amazon Rekognition Custom Labels dataset.
|
@@ -1133,16 +1143,28 @@ module Aws::Rekognition
|
|
1133
1143
|
req.send_request(options)
|
1134
1144
|
end
|
1135
1145
|
|
1136
|
-
# Creates a new Amazon Rekognition
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1146
|
+
# Creates a new Amazon Rekognition project. A project is a group of
|
1147
|
+
# resources (datasets, model versions) that you use to create and manage
|
1148
|
+
# a Amazon Rekognition Custom Labels Model or custom adapter. You can
|
1149
|
+
# specify a feature to create the project with, if no feature is
|
1150
|
+
# specified then Custom Labels is used by default. For adapters, you can
|
1151
|
+
# also choose whether or not to have the project auto update by using
|
1152
|
+
# the AutoUpdate argument. This operation requires permissions to
|
1153
|
+
# perform the `rekognition:CreateProject` action.
|
1142
1154
|
#
|
1143
1155
|
# @option params [required, String] :project_name
|
1144
1156
|
# The name of the project to create.
|
1145
1157
|
#
|
1158
|
+
# @option params [String] :feature
|
1159
|
+
# Specifies feature that is being customized. If no value is provided
|
1160
|
+
# CUSTOM\_LABELS is used as a default.
|
1161
|
+
#
|
1162
|
+
# @option params [String] :auto_update
|
1163
|
+
# Specifies whether automatic retraining should be attempted for the
|
1164
|
+
# versions of the project. Automatic retraining is done as a best
|
1165
|
+
# effort. Required argument for Content Moderation. Applicable only to
|
1166
|
+
# adapters.
|
1167
|
+
#
|
1146
1168
|
# @return [Types::CreateProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1147
1169
|
#
|
1148
1170
|
# * {Types::CreateProjectResponse#project_arn #project_arn} => String
|
@@ -1165,6 +1187,8 @@ module Aws::Rekognition
|
|
1165
1187
|
#
|
1166
1188
|
# resp = client.create_project({
|
1167
1189
|
# project_name: "ProjectName", # required
|
1190
|
+
# feature: "CONTENT_MODERATION", # accepts CONTENT_MODERATION, CUSTOM_LABELS
|
1191
|
+
# auto_update: "ENABLED", # accepts ENABLED, DISABLED
|
1168
1192
|
# })
|
1169
1193
|
#
|
1170
1194
|
# @example Response structure
|
@@ -1178,16 +1202,28 @@ module Aws::Rekognition
|
|
1178
1202
|
req.send_request(options)
|
1179
1203
|
end
|
1180
1204
|
|
1181
|
-
# Creates a new version of
|
1182
|
-
#
|
1183
|
-
#
|
1184
|
-
#
|
1205
|
+
# Creates a new version of Amazon Rekognition project (like a Custom
|
1206
|
+
# Labels model or a custom adapter) and begins training. Models and
|
1207
|
+
# adapters are managed as part of a Rekognition project. The response
|
1208
|
+
# from `CreateProjectVersion` is an Amazon Resource Name (ARN) for the
|
1209
|
+
# project version.
|
1210
|
+
#
|
1211
|
+
# The FeatureConfig operation argument allows you to configure specific
|
1212
|
+
# model or adapter settings. You can provide a description to the
|
1213
|
+
# project version by using the VersionDescription argment. Training can
|
1214
|
+
# take a while to complete. You can get the current status by calling
|
1215
|
+
# DescribeProjectVersions. Training completed successfully if the value
|
1216
|
+
# of the `Status` field is `TRAINING_COMPLETED`. Once training has
|
1217
|
+
# successfully completed, call DescribeProjectVersions to get the
|
1218
|
+
# training results and evaluate the model.
|
1185
1219
|
#
|
1186
|
-
#
|
1187
|
-
#
|
1188
|
-
# in the *Amazon Rekognition Custom Labels Developer Guide*.
|
1220
|
+
# This operation requires permissions to perform the
|
1221
|
+
# `rekognition:CreateProjectVersion` action.
|
1189
1222
|
#
|
1190
|
-
# <note markdown="1">
|
1223
|
+
# <note markdown="1"> *The following applies only to projects with Amazon Rekognition Custom
|
1224
|
+
# Labels as the chosen feature:*
|
1225
|
+
#
|
1226
|
+
# You can train a model in a project that doesn't have associated
|
1191
1227
|
# datasets by specifying manifest files in the `TrainingData` and
|
1192
1228
|
# `TestingData` fields.
|
1193
1229
|
#
|
@@ -1202,57 +1238,42 @@ module Aws::Rekognition
|
|
1202
1238
|
#
|
1203
1239
|
# </note>
|
1204
1240
|
#
|
1205
|
-
# Training takes a while to complete. You can get the current status by
|
1206
|
-
# calling DescribeProjectVersions. Training completed successfully if
|
1207
|
-
# the value of the `Status` field is `TRAINING_COMPLETED`.
|
1208
|
-
#
|
1209
|
-
# If training fails, see Debugging a failed model training in the
|
1210
|
-
# *Amazon Rekognition Custom Labels* developer guide.
|
1211
|
-
#
|
1212
|
-
# Once training has successfully completed, call DescribeProjectVersions
|
1213
|
-
# to get the training results and evaluate the model. For more
|
1214
|
-
# information, see Improving a trained Amazon Rekognition Custom Labels
|
1215
|
-
# model in the *Amazon Rekognition Custom Labels* developers guide.
|
1216
|
-
#
|
1217
|
-
# After evaluating the model, you start the model by calling
|
1218
|
-
# StartProjectVersion.
|
1219
|
-
#
|
1220
|
-
# This operation requires permissions to perform the
|
1221
|
-
# `rekognition:CreateProjectVersion` action.
|
1222
|
-
#
|
1223
1241
|
# @option params [required, String] :project_arn
|
1224
|
-
# The ARN of the Amazon Rekognition
|
1225
|
-
#
|
1242
|
+
# The ARN of the Amazon Rekognition project that will manage the project
|
1243
|
+
# version you want to train.
|
1226
1244
|
#
|
1227
1245
|
# @option params [required, String] :version_name
|
1228
|
-
# A name for the version of the
|
1246
|
+
# A name for the version of the project version. This value must be
|
1247
|
+
# unique.
|
1229
1248
|
#
|
1230
1249
|
# @option params [required, Types::OutputConfig] :output_config
|
1231
|
-
# The Amazon S3 bucket location to store the results of training. The
|
1232
|
-
# bucket can be
|
1233
|
-
# `s3:PutObject`
|
1250
|
+
# The Amazon S3 bucket location to store the results of training. The
|
1251
|
+
# bucket can be any S3 bucket in your AWS account. You need
|
1252
|
+
# `s3:PutObject` permission on the bucket.
|
1234
1253
|
#
|
1235
1254
|
# @option params [Types::TrainingData] :training_data
|
1236
1255
|
# Specifies an external manifest that the services uses to train the
|
1237
|
-
#
|
1256
|
+
# project version. If you specify `TrainingData` you must also specify
|
1238
1257
|
# `TestingData`. The project must not have any associated datasets.
|
1239
1258
|
#
|
1240
1259
|
# @option params [Types::TestingData] :testing_data
|
1241
1260
|
# Specifies an external manifest that the service uses to test the
|
1242
|
-
#
|
1261
|
+
# project version. If you specify `TestingData` you must also specify
|
1243
1262
|
# `TrainingData`. The project must not have any associated datasets.
|
1244
1263
|
#
|
1245
1264
|
# @option params [Hash<String,String>] :tags
|
1246
|
-
# A set of tags (key-value pairs) that you want to attach to the
|
1265
|
+
# A set of tags (key-value pairs) that you want to attach to the project
|
1266
|
+
# version.
|
1247
1267
|
#
|
1248
1268
|
# @option params [String] :kms_key_id
|
1249
1269
|
# The identifier for your AWS Key Management Service key (AWS KMS key).
|
1250
1270
|
# You can supply the Amazon Resource Name (ARN) of your KMS key, the ID
|
1251
1271
|
# of your KMS key, an alias for your KMS key, or an alias ARN. The key
|
1252
|
-
# is used to encrypt training
|
1253
|
-
#
|
1254
|
-
# used to encrypt training results and
|
1255
|
-
# output Amazon S3 bucket
|
1272
|
+
# is used to encrypt training images, test images, and manifest files
|
1273
|
+
# copied into the service for the project version. Your source images
|
1274
|
+
# are unaffected. The key is also used to encrypt training results and
|
1275
|
+
# manifest files written to the output Amazon S3 bucket
|
1276
|
+
# (`OutputConfig`).
|
1256
1277
|
#
|
1257
1278
|
# If you choose to use your own KMS key, you need the following
|
1258
1279
|
# permissions on the KMS key.
|
@@ -1268,6 +1289,14 @@ module Aws::Rekognition
|
|
1268
1289
|
# If you don't specify a value for `KmsKeyId`, images copied into the
|
1269
1290
|
# service are encrypted using a key that AWS owns and manages.
|
1270
1291
|
#
|
1292
|
+
# @option params [String] :version_description
|
1293
|
+
# A description applied to the project version being created.
|
1294
|
+
#
|
1295
|
+
# @option params [Types::CustomizationFeatureConfig] :feature_config
|
1296
|
+
# Feature-specific configuration of the training job. If the job
|
1297
|
+
# configuration does not match the feature type associated with the
|
1298
|
+
# project, an InvalidParameterException is returned.
|
1299
|
+
#
|
1271
1300
|
# @return [Types::CreateProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1272
1301
|
#
|
1273
1302
|
# * {Types::CreateProjectVersionResponse#project_version_arn #project_version_arn} => String
|
@@ -1331,6 +1360,12 @@ module Aws::Rekognition
|
|
1331
1360
|
# "TagKey" => "TagValue",
|
1332
1361
|
# },
|
1333
1362
|
# kms_key_id: "KmsKeyId",
|
1363
|
+
# version_description: "VersionDescription",
|
1364
|
+
# feature_config: {
|
1365
|
+
# content_moderation: {
|
1366
|
+
# confidence_threshold: 1.0,
|
1367
|
+
# },
|
1368
|
+
# },
|
1334
1369
|
# })
|
1335
1370
|
#
|
1336
1371
|
# @example Response structure
|
@@ -1636,6 +1671,10 @@ module Aws::Rekognition
|
|
1636
1671
|
req.send_request(options)
|
1637
1672
|
end
|
1638
1673
|
|
1674
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
1675
|
+
#
|
1676
|
+
# </note>
|
1677
|
+
#
|
1639
1678
|
# Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting
|
1640
1679
|
# a dataset might take while. Use DescribeDataset to check the current
|
1641
1680
|
# status. The dataset is still deleting if the value of `Status` is
|
@@ -1741,9 +1780,9 @@ module Aws::Rekognition
|
|
1741
1780
|
req.send_request(options)
|
1742
1781
|
end
|
1743
1782
|
|
1744
|
-
# Deletes
|
1745
|
-
#
|
1746
|
-
#
|
1783
|
+
# Deletes a Amazon Rekognition project. To delete a project you must
|
1784
|
+
# first delete all models or adapters associated with the project. To
|
1785
|
+
# delete a model or adapter, see DeleteProjectVersion.
|
1747
1786
|
#
|
1748
1787
|
# `DeleteProject` is an asynchronous operation. To check if the project
|
1749
1788
|
# is deleted, call DescribeProjects. The project is deleted when the
|
@@ -1792,6 +1831,10 @@ module Aws::Rekognition
|
|
1792
1831
|
req.send_request(options)
|
1793
1832
|
end
|
1794
1833
|
|
1834
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
1835
|
+
#
|
1836
|
+
# </note>
|
1837
|
+
#
|
1795
1838
|
# Deletes an existing project policy.
|
1796
1839
|
#
|
1797
1840
|
# To get a list of project policies attached to a project, call
|
@@ -1843,18 +1886,20 @@ module Aws::Rekognition
|
|
1843
1886
|
req.send_request(options)
|
1844
1887
|
end
|
1845
1888
|
|
1846
|
-
# Deletes
|
1889
|
+
# Deletes a Rekognition project model or project version, like a Amazon
|
1890
|
+
# Rekognition Custom Labels model or a custom adapter.
|
1847
1891
|
#
|
1848
|
-
# You can't delete a
|
1849
|
-
# check the status of a
|
1850
|
-
# DescribeProjectVersions. To stop a
|
1851
|
-
# StopProjectVersion. If the
|
1892
|
+
# You can't delete a project version if it is running or if it is
|
1893
|
+
# training. To check the status of a project version, use the Status
|
1894
|
+
# field returned from DescribeProjectVersions. To stop a project version
|
1895
|
+
# call StopProjectVersion. If the project version is training, wait
|
1896
|
+
# until it finishes.
|
1852
1897
|
#
|
1853
1898
|
# This operation requires permissions to perform the
|
1854
1899
|
# `rekognition:DeleteProjectVersion` action.
|
1855
1900
|
#
|
1856
1901
|
# @option params [required, String] :project_version_arn
|
1857
|
-
# The Amazon Resource Name (ARN) of the
|
1902
|
+
# The Amazon Resource Name (ARN) of the project version that you want to
|
1858
1903
|
# delete.
|
1859
1904
|
#
|
1860
1905
|
# @return [Types::DeleteProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1883,7 +1928,7 @@ module Aws::Rekognition
|
|
1883
1928
|
#
|
1884
1929
|
# @example Response structure
|
1885
1930
|
#
|
1886
|
-
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
|
1931
|
+
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED", "DEPRECATED", "EXPIRED"
|
1887
1932
|
#
|
1888
1933
|
# @overload delete_project_version(params = {})
|
1889
1934
|
# @param [Hash] params ({})
|
@@ -2007,6 +2052,10 @@ module Aws::Rekognition
|
|
2007
2052
|
req.send_request(options)
|
2008
2053
|
end
|
2009
2054
|
|
2055
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
2056
|
+
#
|
2057
|
+
# </note>
|
2058
|
+
#
|
2010
2059
|
# Describes an Amazon Rekognition Custom Labels dataset. You can get
|
2011
2060
|
# information such as the current status of a dataset and statistics
|
2012
2061
|
# about the images and labels in a dataset.
|
@@ -2073,32 +2122,32 @@ module Aws::Rekognition
|
|
2073
2122
|
req.send_request(options)
|
2074
2123
|
end
|
2075
2124
|
|
2076
|
-
# Lists and describes the versions of
|
2077
|
-
#
|
2125
|
+
# Lists and describes the versions of an Amazon Rekognition project. You
|
2126
|
+
# can specify up to 10 model or adapter versions in
|
2078
2127
|
# `ProjectVersionArns`. If you don't specify a value, descriptions for
|
2079
|
-
# all model versions in the project are returned.
|
2128
|
+
# all model/adapter versions in the project are returned.
|
2080
2129
|
#
|
2081
2130
|
# This operation requires permissions to perform the
|
2082
2131
|
# `rekognition:DescribeProjectVersions` action.
|
2083
2132
|
#
|
2084
2133
|
# @option params [required, String] :project_arn
|
2085
|
-
# The Amazon Resource Name (ARN) of the project that contains the
|
2086
|
-
# you want to describe.
|
2134
|
+
# The Amazon Resource Name (ARN) of the project that contains the
|
2135
|
+
# model/adapter you want to describe.
|
2087
2136
|
#
|
2088
2137
|
# @option params [Array<String>] :version_names
|
2089
|
-
# A list of model version names that you want to describe.
|
2090
|
-
# up to 10 model version names to the list. If
|
2091
|
-
#
|
2092
|
-
# a
|
2093
|
-
# `my-model.2020-01-21T09.10.15` is the version name in the
|
2094
|
-
# ARN.
|
2138
|
+
# A list of model or project version names that you want to describe.
|
2139
|
+
# You can add up to 10 model or project version names to the list. If
|
2140
|
+
# you don't specify a value, all project version descriptions are
|
2141
|
+
# returned. A version name is part of a project version ARN. For
|
2142
|
+
# example, `my-model.2020-01-21T09.10.15` is the version name in the
|
2143
|
+
# following ARN.
|
2095
2144
|
# `arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123`.
|
2096
2145
|
#
|
2097
2146
|
# @option params [String] :next_token
|
2098
2147
|
# If the previous response was incomplete (because there is more results
|
2099
|
-
# to retrieve), Amazon Rekognition
|
2100
|
-
#
|
2101
|
-
#
|
2148
|
+
# to retrieve), Amazon Rekognition returns a pagination token in the
|
2149
|
+
# response. You can use this pagination token to retrieve the next set
|
2150
|
+
# of results.
|
2102
2151
|
#
|
2103
2152
|
# @option params [Integer] :max_results
|
2104
2153
|
# The maximum number of results to return per paginated call. The
|
@@ -2232,7 +2281,7 @@ module Aws::Rekognition
|
|
2232
2281
|
# resp.project_version_descriptions[0].project_version_arn #=> String
|
2233
2282
|
# resp.project_version_descriptions[0].creation_timestamp #=> Time
|
2234
2283
|
# resp.project_version_descriptions[0].min_inference_units #=> Integer
|
2235
|
-
# resp.project_version_descriptions[0].status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
|
2284
|
+
# resp.project_version_descriptions[0].status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED", "DEPRECATED", "EXPIRED"
|
2236
2285
|
# resp.project_version_descriptions[0].status_message #=> String
|
2237
2286
|
# resp.project_version_descriptions[0].billable_training_time_in_seconds #=> Integer
|
2238
2287
|
# resp.project_version_descriptions[0].training_end_timestamp #=> Time
|
@@ -2274,6 +2323,10 @@ module Aws::Rekognition
|
|
2274
2323
|
# resp.project_version_descriptions[0].kms_key_id #=> String
|
2275
2324
|
# resp.project_version_descriptions[0].max_inference_units #=> Integer
|
2276
2325
|
# resp.project_version_descriptions[0].source_project_version_arn #=> String
|
2326
|
+
# resp.project_version_descriptions[0].version_description #=> String
|
2327
|
+
# resp.project_version_descriptions[0].feature #=> String, one of "CONTENT_MODERATION", "CUSTOM_LABELS"
|
2328
|
+
# resp.project_version_descriptions[0].base_model_version #=> String
|
2329
|
+
# resp.project_version_descriptions[0].feature_config.content_moderation.confidence_threshold #=> Float
|
2277
2330
|
# resp.next_token #=> String
|
2278
2331
|
#
|
2279
2332
|
#
|
@@ -2289,16 +2342,15 @@ module Aws::Rekognition
|
|
2289
2342
|
req.send_request(options)
|
2290
2343
|
end
|
2291
2344
|
|
2292
|
-
# Gets information about your
|
2345
|
+
# Gets information about your Rekognition projects.
|
2293
2346
|
#
|
2294
2347
|
# This operation requires permissions to perform the
|
2295
2348
|
# `rekognition:DescribeProjects` action.
|
2296
2349
|
#
|
2297
2350
|
# @option params [String] :next_token
|
2298
2351
|
# If the previous response was incomplete (because there is more results
|
2299
|
-
# to retrieve),
|
2300
|
-
#
|
2301
|
-
# the next set of results.
|
2352
|
+
# to retrieve), Rekognition returns a pagination token in the response.
|
2353
|
+
# You can use this pagination token to retrieve the next set of results.
|
2302
2354
|
#
|
2303
2355
|
# @option params [Integer] :max_results
|
2304
2356
|
# The maximum number of results to return per paginated call. The
|
@@ -2307,9 +2359,13 @@ module Aws::Rekognition
|
|
2307
2359
|
# 100.
|
2308
2360
|
#
|
2309
2361
|
# @option params [Array<String>] :project_names
|
2310
|
-
# A list of the projects that you want
|
2311
|
-
#
|
2312
|
-
#
|
2362
|
+
# A list of the projects that you want Rekognition to describe. If you
|
2363
|
+
# don't specify a value, the response includes descriptions for all the
|
2364
|
+
# projects in your AWS account.
|
2365
|
+
#
|
2366
|
+
# @option params [Array<String>] :features
|
2367
|
+
# Specifies the type of customization to filter projects by. If no value
|
2368
|
+
# is specified, CUSTOM\_LABELS is used as a default.
|
2313
2369
|
#
|
2314
2370
|
# @return [Types::DescribeProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2315
2371
|
#
|
@@ -2364,6 +2420,7 @@ module Aws::Rekognition
|
|
2364
2420
|
# next_token: "ExtendedPaginationToken",
|
2365
2421
|
# max_results: 1,
|
2366
2422
|
# project_names: ["ProjectName"],
|
2423
|
+
# features: ["CONTENT_MODERATION"], # accepts CONTENT_MODERATION, CUSTOM_LABELS
|
2367
2424
|
# })
|
2368
2425
|
#
|
2369
2426
|
# @example Response structure
|
@@ -2379,6 +2436,8 @@ module Aws::Rekognition
|
|
2379
2436
|
# 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"
|
2380
2437
|
# resp.project_descriptions[0].datasets[0].status_message #=> String
|
2381
2438
|
# resp.project_descriptions[0].datasets[0].status_message_code #=> String, one of "SUCCESS", "SERVICE_ERROR", "CLIENT_ERROR"
|
2439
|
+
# resp.project_descriptions[0].feature #=> String, one of "CONTENT_MODERATION", "CUSTOM_LABELS"
|
2440
|
+
# resp.project_descriptions[0].auto_update #=> String, one of "ENABLED", "DISABLED"
|
2382
2441
|
# resp.next_token #=> String
|
2383
2442
|
#
|
2384
2443
|
# @overload describe_projects(params = {})
|
@@ -2456,6 +2515,10 @@ module Aws::Rekognition
|
|
2456
2515
|
req.send_request(options)
|
2457
2516
|
end
|
2458
2517
|
|
2518
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
2519
|
+
#
|
2520
|
+
# </note>
|
2521
|
+
#
|
2459
2522
|
# Detects custom labels in a supplied image by using an Amazon
|
2460
2523
|
# Rekognition Custom Labels model.
|
2461
2524
|
#
|
@@ -2502,7 +2565,10 @@ module Aws::Rekognition
|
|
2502
2565
|
# Rekognition Custom Labels Developer Guide.
|
2503
2566
|
#
|
2504
2567
|
# @option params [required, String] :project_version_arn
|
2505
|
-
# The ARN of the model version that you want to use.
|
2568
|
+
# The ARN of the model version that you want to use. Only models
|
2569
|
+
# associated with Custom Labels projects accepted by the operation. If a
|
2570
|
+
# provided ARN refers to a model version associated with a project for a
|
2571
|
+
# different feature type, then an InvalidParameterException is returned.
|
2506
2572
|
#
|
2507
2573
|
# @option params [required, Types::Image] :image
|
2508
2574
|
# Provides the input image either as bytes or an S3 object.
|
@@ -3124,6 +3190,9 @@ module Aws::Rekognition
|
|
3124
3190
|
# to call Amazon Rekognition operations, passing image bytes is not
|
3125
3191
|
# supported. The image must be either a PNG or JPEG formatted file.
|
3126
3192
|
#
|
3193
|
+
# You can specify an adapter to use when retrieving label predictions by
|
3194
|
+
# providing a `ProjectVersionArn` to the `ProjectVersion` argument.
|
3195
|
+
#
|
3127
3196
|
# @option params [required, Types::Image] :image
|
3128
3197
|
# The input image as base64-encoded bytes or an S3 object. If you use
|
3129
3198
|
# the AWS CLI to call Amazon Rekognition operations, passing
|
@@ -3146,11 +3215,17 @@ module Aws::Rekognition
|
|
3146
3215
|
# Sets up the configuration for human evaluation, including the
|
3147
3216
|
# FlowDefinition the image will be sent to.
|
3148
3217
|
#
|
3218
|
+
# @option params [String] :project_version
|
3219
|
+
# Identifier for the custom adapter. Expects the ProjectVersionArn as a
|
3220
|
+
# value. Use the CreateProject or CreateProjectVersion APIs to create a
|
3221
|
+
# custom adapter.
|
3222
|
+
#
|
3149
3223
|
# @return [Types::DetectModerationLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3150
3224
|
#
|
3151
3225
|
# * {Types::DetectModerationLabelsResponse#moderation_labels #moderation_labels} => Array<Types::ModerationLabel>
|
3152
3226
|
# * {Types::DetectModerationLabelsResponse#moderation_model_version #moderation_model_version} => String
|
3153
3227
|
# * {Types::DetectModerationLabelsResponse#human_loop_activation_output #human_loop_activation_output} => Types::HumanLoopActivationOutput
|
3228
|
+
# * {Types::DetectModerationLabelsResponse#project_version #project_version} => String
|
3154
3229
|
#
|
3155
3230
|
# @example Request syntax with placeholder values
|
3156
3231
|
#
|
@@ -3171,6 +3246,7 @@ module Aws::Rekognition
|
|
3171
3246
|
# content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
|
3172
3247
|
# },
|
3173
3248
|
# },
|
3249
|
+
# project_version: "ProjectVersionId",
|
3174
3250
|
# })
|
3175
3251
|
#
|
3176
3252
|
# @example Response structure
|
@@ -3184,6 +3260,7 @@ module Aws::Rekognition
|
|
3184
3260
|
# resp.human_loop_activation_output.human_loop_activation_reasons #=> Array
|
3185
3261
|
# resp.human_loop_activation_output.human_loop_activation_reasons[0] #=> String
|
3186
3262
|
# resp.human_loop_activation_output.human_loop_activation_conditions_evaluation_results #=> String
|
3263
|
+
# resp.project_version #=> String
|
3187
3264
|
#
|
3188
3265
|
# @overload detect_moderation_labels(params = {})
|
3189
3266
|
# @param [Hash] params ({})
|
@@ -3513,6 +3590,10 @@ module Aws::Rekognition
|
|
3513
3590
|
req.send_request(options)
|
3514
3591
|
end
|
3515
3592
|
|
3593
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
3594
|
+
#
|
3595
|
+
# </note>
|
3596
|
+
#
|
3516
3597
|
# Distributes the entries (images) in a training dataset across the
|
3517
3598
|
# training dataset and the test dataset for a project.
|
3518
3599
|
# `DistributeDatasetEntries` moves 20% of the training dataset images to
|
@@ -4468,6 +4549,111 @@ module Aws::Rekognition
|
|
4468
4549
|
req.send_request(options)
|
4469
4550
|
end
|
4470
4551
|
|
4552
|
+
# Retrieves the results for a given media analysis job. Takes a `JobId`
|
4553
|
+
# returned by StartMediaAnalysisJob.
|
4554
|
+
#
|
4555
|
+
# @option params [required, String] :job_id
|
4556
|
+
# Unique identifier for the media analysis job for which you want to
|
4557
|
+
# retrieve results.
|
4558
|
+
#
|
4559
|
+
# @return [Types::GetMediaAnalysisJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4560
|
+
#
|
4561
|
+
# * {Types::GetMediaAnalysisJobResponse#job_id #job_id} => String
|
4562
|
+
# * {Types::GetMediaAnalysisJobResponse#job_name #job_name} => String
|
4563
|
+
# * {Types::GetMediaAnalysisJobResponse#operations_config #operations_config} => Types::MediaAnalysisOperationsConfig
|
4564
|
+
# * {Types::GetMediaAnalysisJobResponse#status #status} => String
|
4565
|
+
# * {Types::GetMediaAnalysisJobResponse#failure_details #failure_details} => Types::MediaAnalysisJobFailureDetails
|
4566
|
+
# * {Types::GetMediaAnalysisJobResponse#creation_timestamp #creation_timestamp} => Time
|
4567
|
+
# * {Types::GetMediaAnalysisJobResponse#completion_timestamp #completion_timestamp} => Time
|
4568
|
+
# * {Types::GetMediaAnalysisJobResponse#input #input} => Types::MediaAnalysisInput
|
4569
|
+
# * {Types::GetMediaAnalysisJobResponse#output_config #output_config} => Types::MediaAnalysisOutputConfig
|
4570
|
+
# * {Types::GetMediaAnalysisJobResponse#kms_key_id #kms_key_id} => String
|
4571
|
+
# * {Types::GetMediaAnalysisJobResponse#results #results} => Types::MediaAnalysisResults
|
4572
|
+
# * {Types::GetMediaAnalysisJobResponse#manifest_summary #manifest_summary} => Types::MediaAnalysisManifestSummary
|
4573
|
+
#
|
4574
|
+
#
|
4575
|
+
# @example Example: GetMediaAnalysisJob
|
4576
|
+
#
|
4577
|
+
# # Retrieves the results for a given media analysis job.
|
4578
|
+
#
|
4579
|
+
# resp = client.get_media_analysis_job({
|
4580
|
+
# job_id: "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
|
4581
|
+
# })
|
4582
|
+
#
|
4583
|
+
# resp.to_h outputs the following:
|
4584
|
+
# {
|
4585
|
+
# completion_timestamp: Time.parse("2023-07-28T08:05:51.958000-07:00"),
|
4586
|
+
# creation_timestamp: Time.parse("2023-07-28T08:05:51.958000-06:00"),
|
4587
|
+
# input: {
|
4588
|
+
# s3_object: {
|
4589
|
+
# bucket: "input-bucket",
|
4590
|
+
# name: "input-manifest.json",
|
4591
|
+
# },
|
4592
|
+
# },
|
4593
|
+
# job_id: "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
|
4594
|
+
# job_name: "job-name",
|
4595
|
+
# manifest_summary: {
|
4596
|
+
# s3_object: {
|
4597
|
+
# bucket: "output-bucket",
|
4598
|
+
# name: "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-manifest-summary.json",
|
4599
|
+
# },
|
4600
|
+
# },
|
4601
|
+
# operations_config: {
|
4602
|
+
# detect_moderation_labels: {
|
4603
|
+
# min_confidence: 50,
|
4604
|
+
# project_version: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
|
4605
|
+
# },
|
4606
|
+
# },
|
4607
|
+
# output_config: {
|
4608
|
+
# s3_bucket: "output-bucket",
|
4609
|
+
# s3_key_prefix: "output-location",
|
4610
|
+
# },
|
4611
|
+
# results: {
|
4612
|
+
# s3_object: {
|
4613
|
+
# bucket: "output-bucket",
|
4614
|
+
# name: "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-results.jsonl",
|
4615
|
+
# },
|
4616
|
+
# },
|
4617
|
+
# status: "SUCCEEDED",
|
4618
|
+
# }
|
4619
|
+
#
|
4620
|
+
# @example Request syntax with placeholder values
|
4621
|
+
#
|
4622
|
+
# resp = client.get_media_analysis_job({
|
4623
|
+
# job_id: "MediaAnalysisJobId", # required
|
4624
|
+
# })
|
4625
|
+
#
|
4626
|
+
# @example Response structure
|
4627
|
+
#
|
4628
|
+
# resp.job_id #=> String
|
4629
|
+
# resp.job_name #=> String
|
4630
|
+
# resp.operations_config.detect_moderation_labels.min_confidence #=> Float
|
4631
|
+
# resp.operations_config.detect_moderation_labels.project_version #=> String
|
4632
|
+
# resp.status #=> String, one of "CREATED", "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
4633
|
+
# resp.failure_details.code #=> String, one of "INTERNAL_ERROR", "INVALID_S3_OBJECT", "INVALID_MANIFEST", "INVALID_OUTPUT_CONFIG", "INVALID_KMS_KEY", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "RESOURCE_NOT_READY", "THROTTLED"
|
4634
|
+
# resp.failure_details.message #=> String
|
4635
|
+
# resp.creation_timestamp #=> Time
|
4636
|
+
# resp.completion_timestamp #=> Time
|
4637
|
+
# resp.input.s3_object.bucket #=> String
|
4638
|
+
# resp.input.s3_object.name #=> String
|
4639
|
+
# resp.input.s3_object.version #=> String
|
4640
|
+
# resp.output_config.s3_bucket #=> String
|
4641
|
+
# resp.output_config.s3_key_prefix #=> String
|
4642
|
+
# resp.kms_key_id #=> String
|
4643
|
+
# resp.results.s3_object.bucket #=> String
|
4644
|
+
# resp.results.s3_object.name #=> String
|
4645
|
+
# resp.results.s3_object.version #=> String
|
4646
|
+
# resp.manifest_summary.s3_object.bucket #=> String
|
4647
|
+
# resp.manifest_summary.s3_object.name #=> String
|
4648
|
+
# resp.manifest_summary.s3_object.version #=> String
|
4649
|
+
#
|
4650
|
+
# @overload get_media_analysis_job(params = {})
|
4651
|
+
# @param [Hash] params ({})
|
4652
|
+
def get_media_analysis_job(params = {}, options = {})
|
4653
|
+
req = build_request(:get_media_analysis_job, params)
|
4654
|
+
req.send_request(options)
|
4655
|
+
end
|
4656
|
+
|
4471
4657
|
# Gets the path tracking results of a Amazon Rekognition Video analysis
|
4472
4658
|
# started by StartPersonTracking.
|
4473
4659
|
#
|
@@ -5359,6 +5545,10 @@ module Aws::Rekognition
|
|
5359
5545
|
req.send_request(options)
|
5360
5546
|
end
|
5361
5547
|
|
5548
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
5549
|
+
#
|
5550
|
+
# </note>
|
5551
|
+
#
|
5362
5552
|
# Lists the entries (images) within a dataset. An entry is a JSON Line
|
5363
5553
|
# that contains the information for a single image, including the image
|
5364
5554
|
# location, assigned labels, and object location bounding boxes. For
|
@@ -5476,6 +5666,10 @@ module Aws::Rekognition
|
|
5476
5666
|
req.send_request(options)
|
5477
5667
|
end
|
5478
5668
|
|
5669
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
5670
|
+
#
|
5671
|
+
# </note>
|
5672
|
+
#
|
5479
5673
|
# Lists the labels in a dataset. Amazon Rekognition Custom Labels uses
|
5480
5674
|
# labels to describe images. For more information, see [Labeling
|
5481
5675
|
# images][1].
|
@@ -5692,6 +5886,119 @@ module Aws::Rekognition
|
|
5692
5886
|
req.send_request(options)
|
5693
5887
|
end
|
5694
5888
|
|
5889
|
+
# Returns a list of media analysis jobs. Results are sorted by
|
5890
|
+
# `CreationTimestamp` in descending order.
|
5891
|
+
#
|
5892
|
+
# @option params [String] :next_token
|
5893
|
+
# Pagination token, if the previous response was incomplete.
|
5894
|
+
#
|
5895
|
+
# @option params [Integer] :max_results
|
5896
|
+
# The maximum number of results to return per paginated call. The
|
5897
|
+
# largest value user can specify is 100. If user specifies a value
|
5898
|
+
# greater than 100, an `InvalidParameterException` error occurs. The
|
5899
|
+
# default value is 100.
|
5900
|
+
#
|
5901
|
+
# @return [Types::ListMediaAnalysisJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5902
|
+
#
|
5903
|
+
# * {Types::ListMediaAnalysisJobsResponse#next_token #next_token} => String
|
5904
|
+
# * {Types::ListMediaAnalysisJobsResponse#media_analysis_jobs #media_analysis_jobs} => Array<Types::MediaAnalysisJobDescription>
|
5905
|
+
#
|
5906
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5907
|
+
#
|
5908
|
+
#
|
5909
|
+
# @example Example: ListMediaAnalysisJobs
|
5910
|
+
#
|
5911
|
+
# # Returns a list of media analysis jobs.
|
5912
|
+
#
|
5913
|
+
# resp = client.list_media_analysis_jobs({
|
5914
|
+
# max_results: 10,
|
5915
|
+
# })
|
5916
|
+
#
|
5917
|
+
# resp.to_h outputs the following:
|
5918
|
+
# {
|
5919
|
+
# media_analysis_jobs: [
|
5920
|
+
# {
|
5921
|
+
# completion_timestamp: Time.parse("2023-07-28T08:05:51.958000-07:00"),
|
5922
|
+
# creation_timestamp: Time.parse("2023-07-28T08:05:51.958000-06:00"),
|
5923
|
+
# input: {
|
5924
|
+
# s3_object: {
|
5925
|
+
# bucket: "input-bucket",
|
5926
|
+
# name: "input-manifest.json",
|
5927
|
+
# },
|
5928
|
+
# },
|
5929
|
+
# job_id: "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
|
5930
|
+
# job_name: "job-name",
|
5931
|
+
# manifest_summary: {
|
5932
|
+
# s3_object: {
|
5933
|
+
# bucket: "output-bucket",
|
5934
|
+
# name: "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-manifest-summary.json",
|
5935
|
+
# },
|
5936
|
+
# },
|
5937
|
+
# operations_config: {
|
5938
|
+
# detect_moderation_labels: {
|
5939
|
+
# min_confidence: 50,
|
5940
|
+
# project_version: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
|
5941
|
+
# },
|
5942
|
+
# },
|
5943
|
+
# output_config: {
|
5944
|
+
# s3_bucket: "output-bucket",
|
5945
|
+
# s3_key_prefix: "output-location",
|
5946
|
+
# },
|
5947
|
+
# results: {
|
5948
|
+
# s3_object: {
|
5949
|
+
# bucket: "output-bucket",
|
5950
|
+
# name: "output-location/861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537-results.jsonl",
|
5951
|
+
# },
|
5952
|
+
# },
|
5953
|
+
# status: "SUCCEEDED",
|
5954
|
+
# },
|
5955
|
+
# ],
|
5956
|
+
# }
|
5957
|
+
#
|
5958
|
+
# @example Request syntax with placeholder values
|
5959
|
+
#
|
5960
|
+
# resp = client.list_media_analysis_jobs({
|
5961
|
+
# next_token: "ExtendedPaginationToken",
|
5962
|
+
# max_results: 1,
|
5963
|
+
# })
|
5964
|
+
#
|
5965
|
+
# @example Response structure
|
5966
|
+
#
|
5967
|
+
# resp.next_token #=> String
|
5968
|
+
# resp.media_analysis_jobs #=> Array
|
5969
|
+
# resp.media_analysis_jobs[0].job_id #=> String
|
5970
|
+
# resp.media_analysis_jobs[0].job_name #=> String
|
5971
|
+
# resp.media_analysis_jobs[0].operations_config.detect_moderation_labels.min_confidence #=> Float
|
5972
|
+
# resp.media_analysis_jobs[0].operations_config.detect_moderation_labels.project_version #=> String
|
5973
|
+
# resp.media_analysis_jobs[0].status #=> String, one of "CREATED", "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
5974
|
+
# resp.media_analysis_jobs[0].failure_details.code #=> String, one of "INTERNAL_ERROR", "INVALID_S3_OBJECT", "INVALID_MANIFEST", "INVALID_OUTPUT_CONFIG", "INVALID_KMS_KEY", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "RESOURCE_NOT_READY", "THROTTLED"
|
5975
|
+
# resp.media_analysis_jobs[0].failure_details.message #=> String
|
5976
|
+
# resp.media_analysis_jobs[0].creation_timestamp #=> Time
|
5977
|
+
# resp.media_analysis_jobs[0].completion_timestamp #=> Time
|
5978
|
+
# resp.media_analysis_jobs[0].input.s3_object.bucket #=> String
|
5979
|
+
# resp.media_analysis_jobs[0].input.s3_object.name #=> String
|
5980
|
+
# resp.media_analysis_jobs[0].input.s3_object.version #=> String
|
5981
|
+
# resp.media_analysis_jobs[0].output_config.s3_bucket #=> String
|
5982
|
+
# resp.media_analysis_jobs[0].output_config.s3_key_prefix #=> String
|
5983
|
+
# resp.media_analysis_jobs[0].kms_key_id #=> String
|
5984
|
+
# resp.media_analysis_jobs[0].results.s3_object.bucket #=> String
|
5985
|
+
# resp.media_analysis_jobs[0].results.s3_object.name #=> String
|
5986
|
+
# resp.media_analysis_jobs[0].results.s3_object.version #=> String
|
5987
|
+
# resp.media_analysis_jobs[0].manifest_summary.s3_object.bucket #=> String
|
5988
|
+
# resp.media_analysis_jobs[0].manifest_summary.s3_object.name #=> String
|
5989
|
+
# resp.media_analysis_jobs[0].manifest_summary.s3_object.version #=> String
|
5990
|
+
#
|
5991
|
+
# @overload list_media_analysis_jobs(params = {})
|
5992
|
+
# @param [Hash] params ({})
|
5993
|
+
def list_media_analysis_jobs(params = {}, options = {})
|
5994
|
+
req = build_request(:list_media_analysis_jobs, params)
|
5995
|
+
req.send_request(options)
|
5996
|
+
end
|
5997
|
+
|
5998
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
5999
|
+
#
|
6000
|
+
# </note>
|
6001
|
+
#
|
5695
6002
|
# Gets a list of the project policies attached to a project.
|
5696
6003
|
#
|
5697
6004
|
# To attach a project policy to a project, call PutProjectPolicy. To
|
@@ -5916,11 +6223,16 @@ module Aws::Rekognition
|
|
5916
6223
|
req.send_request(options)
|
5917
6224
|
end
|
5918
6225
|
|
6226
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
6227
|
+
#
|
6228
|
+
# </note>
|
6229
|
+
#
|
5919
6230
|
# Attaches a project policy to a Amazon Rekognition Custom Labels
|
5920
6231
|
# project in a trusting AWS account. A project policy specifies that a
|
5921
6232
|
# trusted AWS account can copy a model version from a trusting AWS
|
5922
6233
|
# account to a project in the trusted AWS account. To copy a model
|
5923
|
-
# version you use the CopyProjectVersion operation.
|
6234
|
+
# version you use the CopyProjectVersion operation. Only applies to
|
6235
|
+
# Custom Labels projects.
|
5924
6236
|
#
|
5925
6237
|
# For more information about the format of a project policy document,
|
5926
6238
|
# see Attaching a project policy (SDK) in the *Amazon Rekognition Custom
|
@@ -7242,6 +7554,108 @@ module Aws::Rekognition
|
|
7242
7554
|
req.send_request(options)
|
7243
7555
|
end
|
7244
7556
|
|
7557
|
+
# Initiates a new media analysis job. Accepts a manifest file in an
|
7558
|
+
# Amazon S3 bucket. The output is a manifest file and a summary of the
|
7559
|
+
# manifest stored in the Amazon S3 bucket.
|
7560
|
+
#
|
7561
|
+
# @option params [String] :client_request_token
|
7562
|
+
# Idempotency token used to prevent the accidental creation of duplicate
|
7563
|
+
# versions. If you use the same token with multiple
|
7564
|
+
# `StartMediaAnalysisJobRequest` requests, the same response is
|
7565
|
+
# returned. Use `ClientRequestToken` to prevent the same request from
|
7566
|
+
# being processed more than once.
|
7567
|
+
#
|
7568
|
+
# **A suitable default value is auto-generated.** You should normally
|
7569
|
+
# not need to pass this option.**
|
7570
|
+
#
|
7571
|
+
# @option params [String] :job_name
|
7572
|
+
# The name of the job. Does not have to be unique.
|
7573
|
+
#
|
7574
|
+
# @option params [required, Types::MediaAnalysisOperationsConfig] :operations_config
|
7575
|
+
# Configuration options for the media analysis job to be created.
|
7576
|
+
#
|
7577
|
+
# @option params [required, Types::MediaAnalysisInput] :input
|
7578
|
+
# Input data to be analyzed by the job.
|
7579
|
+
#
|
7580
|
+
# @option params [required, Types::MediaAnalysisOutputConfig] :output_config
|
7581
|
+
# The Amazon S3 bucket location to store the results.
|
7582
|
+
#
|
7583
|
+
# @option params [String] :kms_key_id
|
7584
|
+
# The identifier of customer managed AWS KMS key (name or ARN). The key
|
7585
|
+
# is used to encrypt images copied into the service. The key is also
|
7586
|
+
# used to encrypt results and manifest files written to the output
|
7587
|
+
# Amazon S3 bucket.
|
7588
|
+
#
|
7589
|
+
# @return [Types::StartMediaAnalysisJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7590
|
+
#
|
7591
|
+
# * {Types::StartMediaAnalysisJobResponse#job_id #job_id} => String
|
7592
|
+
#
|
7593
|
+
#
|
7594
|
+
# @example Example: StartMediaAnalysisJob
|
7595
|
+
#
|
7596
|
+
# # Initiates a new media analysis job.
|
7597
|
+
#
|
7598
|
+
# resp = client.start_media_analysis_job({
|
7599
|
+
# input: {
|
7600
|
+
# s3_object: {
|
7601
|
+
# bucket: "input-bucket",
|
7602
|
+
# name: "input-manifest.json",
|
7603
|
+
# },
|
7604
|
+
# },
|
7605
|
+
# job_name: "job-name",
|
7606
|
+
# operations_config: {
|
7607
|
+
# detect_moderation_labels: {
|
7608
|
+
# min_confidence: 50,
|
7609
|
+
# project_version: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
|
7610
|
+
# },
|
7611
|
+
# },
|
7612
|
+
# output_config: {
|
7613
|
+
# s3_bucket: "output-bucket",
|
7614
|
+
# s3_key_prefix: "output-location",
|
7615
|
+
# },
|
7616
|
+
# })
|
7617
|
+
#
|
7618
|
+
# resp.to_h outputs the following:
|
7619
|
+
# {
|
7620
|
+
# job_id: "861a0645d98ef88efb75477628c011c04942d9d5f58faf2703c393c8cf8c1537",
|
7621
|
+
# }
|
7622
|
+
#
|
7623
|
+
# @example Request syntax with placeholder values
|
7624
|
+
#
|
7625
|
+
# resp = client.start_media_analysis_job({
|
7626
|
+
# client_request_token: "ClientRequestToken",
|
7627
|
+
# job_name: "MediaAnalysisJobName",
|
7628
|
+
# operations_config: { # required
|
7629
|
+
# detect_moderation_labels: {
|
7630
|
+
# min_confidence: 1.0,
|
7631
|
+
# project_version: "ProjectVersionId",
|
7632
|
+
# },
|
7633
|
+
# },
|
7634
|
+
# input: { # required
|
7635
|
+
# s3_object: { # required
|
7636
|
+
# bucket: "S3Bucket",
|
7637
|
+
# name: "S3ObjectName",
|
7638
|
+
# version: "S3ObjectVersion",
|
7639
|
+
# },
|
7640
|
+
# },
|
7641
|
+
# output_config: { # required
|
7642
|
+
# s3_bucket: "S3Bucket", # required
|
7643
|
+
# s3_key_prefix: "MediaAnalysisS3KeyPrefix",
|
7644
|
+
# },
|
7645
|
+
# kms_key_id: "KmsKeyId",
|
7646
|
+
# })
|
7647
|
+
#
|
7648
|
+
# @example Response structure
|
7649
|
+
#
|
7650
|
+
# resp.job_id #=> String
|
7651
|
+
#
|
7652
|
+
# @overload start_media_analysis_job(params = {})
|
7653
|
+
# @param [Hash] params ({})
|
7654
|
+
def start_media_analysis_job(params = {}, options = {})
|
7655
|
+
req = build_request(:start_media_analysis_job, params)
|
7656
|
+
req.send_request(options)
|
7657
|
+
end
|
7658
|
+
|
7245
7659
|
# Starts the asynchronous tracking of a person's path in a stored
|
7246
7660
|
# video.
|
7247
7661
|
#
|
@@ -7313,6 +7727,10 @@ module Aws::Rekognition
|
|
7313
7727
|
req.send_request(options)
|
7314
7728
|
end
|
7315
7729
|
|
7730
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
7731
|
+
#
|
7732
|
+
# </note>
|
7733
|
+
#
|
7316
7734
|
# Starts the running of the version of a model. Starting a model takes a
|
7317
7735
|
# while to complete. To check the current state of the model, use
|
7318
7736
|
# DescribeProjectVersions.
|
@@ -7325,9 +7743,6 @@ module Aws::Rekognition
|
|
7325
7743
|
#
|
7326
7744
|
# </note>
|
7327
7745
|
#
|
7328
|
-
# For more information, see *Running a trained Amazon Rekognition Custom
|
7329
|
-
# Labels model* in the Amazon Rekognition Custom Labels Guide.
|
7330
|
-
#
|
7331
7746
|
# This operation requires permissions to perform the
|
7332
7747
|
# `rekognition:StartProjectVersion` action.
|
7333
7748
|
#
|
@@ -7339,11 +7754,6 @@ module Aws::Rekognition
|
|
7339
7754
|
# The minimum number of inference units to use. A single inference unit
|
7340
7755
|
# represents 1 hour of processing.
|
7341
7756
|
#
|
7342
|
-
# For information about the number of transactions per second (TPS) that
|
7343
|
-
# an inference unit can support, see *Running a trained Amazon
|
7344
|
-
# Rekognition Custom Labels model* in the Amazon Rekognition Custom
|
7345
|
-
# Labels Guide.
|
7346
|
-
#
|
7347
7757
|
# Use a higher number to increase the TPS throughput of your model. You
|
7348
7758
|
# are charged for the number of inference units that you use.
|
7349
7759
|
#
|
@@ -7382,7 +7792,7 @@ module Aws::Rekognition
|
|
7382
7792
|
#
|
7383
7793
|
# @example Response structure
|
7384
7794
|
#
|
7385
|
-
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
|
7795
|
+
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED", "DEPRECATED", "EXPIRED"
|
7386
7796
|
#
|
7387
7797
|
# @overload start_project_version(params = {})
|
7388
7798
|
# @param [Hash] params ({})
|
@@ -7665,15 +8075,20 @@ module Aws::Rekognition
|
|
7665
8075
|
req.send_request(options)
|
7666
8076
|
end
|
7667
8077
|
|
8078
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
8079
|
+
#
|
8080
|
+
# </note>
|
8081
|
+
#
|
7668
8082
|
# Stops a running model. The operation might take a while to complete.
|
7669
|
-
# To check the current status, call DescribeProjectVersions.
|
8083
|
+
# To check the current status, call DescribeProjectVersions. Only
|
8084
|
+
# applies to Custom Labels projects.
|
7670
8085
|
#
|
7671
8086
|
# This operation requires permissions to perform the
|
7672
8087
|
# `rekognition:StopProjectVersion` action.
|
7673
8088
|
#
|
7674
8089
|
# @option params [required, String] :project_version_arn
|
7675
8090
|
# The Amazon Resource Name (ARN) of the model version that you want to
|
7676
|
-
#
|
8091
|
+
# stop.
|
7677
8092
|
#
|
7678
8093
|
# This operation requires permissions to perform the
|
7679
8094
|
# `rekognition:StopProjectVersion` action.
|
@@ -7704,7 +8119,7 @@ module Aws::Rekognition
|
|
7704
8119
|
#
|
7705
8120
|
# @example Response structure
|
7706
8121
|
#
|
7707
|
-
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED"
|
8122
|
+
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED", "DEPRECATED", "EXPIRED"
|
7708
8123
|
#
|
7709
8124
|
# @overload stop_project_version(params = {})
|
7710
8125
|
# @param [Hash] params ({})
|
@@ -7799,6 +8214,10 @@ module Aws::Rekognition
|
|
7799
8214
|
req.send_request(options)
|
7800
8215
|
end
|
7801
8216
|
|
8217
|
+
# <note markdown="1"> This operation applies only to Amazon Rekognition Custom Labels.
|
8218
|
+
#
|
8219
|
+
# </note>
|
8220
|
+
#
|
7802
8221
|
# Adds or updates one or more entries (images) in a dataset. An entry is
|
7803
8222
|
# a JSON Line which contains the information for a single image,
|
7804
8223
|
# including the image location, assigned labels, and object location
|
@@ -7949,7 +8368,7 @@ module Aws::Rekognition
|
|
7949
8368
|
params: params,
|
7950
8369
|
config: config)
|
7951
8370
|
context[:gem_name] = 'aws-sdk-rekognition'
|
7952
|
-
context[:gem_version] = '1.
|
8371
|
+
context[:gem_version] = '1.89.0'
|
7953
8372
|
Seahorse::Client::Request.new(handlers, context)
|
7954
8373
|
end
|
7955
8374
|
|