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
@@ -964,8 +964,22 @@ module Aws::Rekognition
|
|
964
964
|
# The name of the project to create.
|
965
965
|
# @return [String]
|
966
966
|
#
|
967
|
+
# @!attribute [rw] feature
|
968
|
+
# Specifies feature that is being customized. If no value is provided
|
969
|
+
# CUSTOM\_LABELS is used as a default.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @!attribute [rw] auto_update
|
973
|
+
# Specifies whether automatic retraining should be attempted for the
|
974
|
+
# versions of the project. Automatic retraining is done as a best
|
975
|
+
# effort. Required argument for Content Moderation. Applicable only to
|
976
|
+
# adapters.
|
977
|
+
# @return [String]
|
978
|
+
#
|
967
979
|
class CreateProjectRequest < Struct.new(
|
968
|
-
:project_name
|
980
|
+
:project_name,
|
981
|
+
:feature,
|
982
|
+
:auto_update)
|
969
983
|
SENSITIVE = []
|
970
984
|
include Aws::Structure
|
971
985
|
end
|
@@ -982,45 +996,47 @@ module Aws::Rekognition
|
|
982
996
|
end
|
983
997
|
|
984
998
|
# @!attribute [rw] project_arn
|
985
|
-
# The ARN of the Amazon Rekognition
|
986
|
-
#
|
999
|
+
# The ARN of the Amazon Rekognition project that will manage the
|
1000
|
+
# project version you want to train.
|
987
1001
|
# @return [String]
|
988
1002
|
#
|
989
1003
|
# @!attribute [rw] version_name
|
990
|
-
# A name for the version of the
|
1004
|
+
# A name for the version of the project version. This value must be
|
1005
|
+
# unique.
|
991
1006
|
# @return [String]
|
992
1007
|
#
|
993
1008
|
# @!attribute [rw] output_config
|
994
1009
|
# The Amazon S3 bucket location to store the results of training. The
|
995
|
-
#
|
996
|
-
# `s3:PutObject`
|
1010
|
+
# bucket can be any S3 bucket in your AWS account. You need
|
1011
|
+
# `s3:PutObject` permission on the bucket.
|
997
1012
|
# @return [Types::OutputConfig]
|
998
1013
|
#
|
999
1014
|
# @!attribute [rw] training_data
|
1000
1015
|
# Specifies an external manifest that the services uses to train the
|
1001
|
-
#
|
1016
|
+
# project version. If you specify `TrainingData` you must also specify
|
1002
1017
|
# `TestingData`. The project must not have any associated datasets.
|
1003
1018
|
# @return [Types::TrainingData]
|
1004
1019
|
#
|
1005
1020
|
# @!attribute [rw] testing_data
|
1006
1021
|
# Specifies an external manifest that the service uses to test the
|
1007
|
-
#
|
1022
|
+
# project version. If you specify `TestingData` you must also specify
|
1008
1023
|
# `TrainingData`. The project must not have any associated datasets.
|
1009
1024
|
# @return [Types::TestingData]
|
1010
1025
|
#
|
1011
1026
|
# @!attribute [rw] tags
|
1012
1027
|
# A set of tags (key-value pairs) that you want to attach to the
|
1013
|
-
#
|
1028
|
+
# project version.
|
1014
1029
|
# @return [Hash<String,String>]
|
1015
1030
|
#
|
1016
1031
|
# @!attribute [rw] kms_key_id
|
1017
1032
|
# The identifier for your AWS Key Management Service key (AWS KMS
|
1018
1033
|
# key). You can supply the Amazon Resource Name (ARN) of your KMS key,
|
1019
1034
|
# the ID of your KMS key, an alias for your KMS key, or an alias ARN.
|
1020
|
-
# The key is used to encrypt training
|
1021
|
-
#
|
1022
|
-
# key is also used to encrypt
|
1023
|
-
# written to the output Amazon S3
|
1035
|
+
# The key is used to encrypt training images, test images, and
|
1036
|
+
# manifest files copied into the service for the project version. Your
|
1037
|
+
# source images are unaffected. The key is also used to encrypt
|
1038
|
+
# training results and manifest files written to the output Amazon S3
|
1039
|
+
# bucket (`OutputConfig`).
|
1024
1040
|
#
|
1025
1041
|
# If you choose to use your own KMS key, you need the following
|
1026
1042
|
# permissions on the KMS key.
|
@@ -1037,6 +1053,16 @@ module Aws::Rekognition
|
|
1037
1053
|
# service are encrypted using a key that AWS owns and manages.
|
1038
1054
|
# @return [String]
|
1039
1055
|
#
|
1056
|
+
# @!attribute [rw] version_description
|
1057
|
+
# A description applied to the project version being created.
|
1058
|
+
# @return [String]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] feature_config
|
1061
|
+
# Feature-specific configuration of the training job. If the job
|
1062
|
+
# configuration does not match the feature type associated with the
|
1063
|
+
# project, an InvalidParameterException is returned.
|
1064
|
+
# @return [Types::CustomizationFeatureConfig]
|
1065
|
+
#
|
1040
1066
|
class CreateProjectVersionRequest < Struct.new(
|
1041
1067
|
:project_arn,
|
1042
1068
|
:version_name,
|
@@ -1044,13 +1070,15 @@ module Aws::Rekognition
|
|
1044
1070
|
:training_data,
|
1045
1071
|
:testing_data,
|
1046
1072
|
:tags,
|
1047
|
-
:kms_key_id
|
1073
|
+
:kms_key_id,
|
1074
|
+
:version_description,
|
1075
|
+
:feature_config)
|
1048
1076
|
SENSITIVE = []
|
1049
1077
|
include Aws::Structure
|
1050
1078
|
end
|
1051
1079
|
|
1052
1080
|
# @!attribute [rw] project_version_arn
|
1053
|
-
# The ARN of the model version that was created. Use
|
1081
|
+
# The ARN of the model or the project version that was created. Use
|
1054
1082
|
# `DescribeProjectVersion` to get the current status of the training
|
1055
1083
|
# operation.
|
1056
1084
|
# @return [String]
|
@@ -1229,6 +1257,34 @@ module Aws::Rekognition
|
|
1229
1257
|
include Aws::Structure
|
1230
1258
|
end
|
1231
1259
|
|
1260
|
+
# Feature specific configuration for the training job. Configuration
|
1261
|
+
# provided for the job must match the feature type parameter associated
|
1262
|
+
# with project. If configuration and feature type do not match an
|
1263
|
+
# InvalidParameterException is returned.
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] content_moderation
|
1266
|
+
# Configuration options for Custom Moderation training.
|
1267
|
+
# @return [Types::CustomizationFeatureContentModerationConfig]
|
1268
|
+
#
|
1269
|
+
class CustomizationFeatureConfig < Struct.new(
|
1270
|
+
:content_moderation)
|
1271
|
+
SENSITIVE = []
|
1272
|
+
include Aws::Structure
|
1273
|
+
end
|
1274
|
+
|
1275
|
+
# Configuration options for Content Moderation training.
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] confidence_threshold
|
1278
|
+
# The confidence level you plan to use to identify if unsafe content
|
1279
|
+
# is present during inference.
|
1280
|
+
# @return [Float]
|
1281
|
+
#
|
1282
|
+
class CustomizationFeatureContentModerationConfig < Struct.new(
|
1283
|
+
:confidence_threshold)
|
1284
|
+
SENSITIVE = []
|
1285
|
+
include Aws::Structure
|
1286
|
+
end
|
1287
|
+
|
1232
1288
|
# Describes updates or additions to a dataset. A Single update or
|
1233
1289
|
# addition is an entry (JSON Line) that provides information about a
|
1234
1290
|
# single image. To update an existing entry, you match the `source-ref`
|
@@ -1545,8 +1601,8 @@ module Aws::Rekognition
|
|
1545
1601
|
end
|
1546
1602
|
|
1547
1603
|
# @!attribute [rw] project_version_arn
|
1548
|
-
# The Amazon Resource Name (ARN) of the
|
1549
|
-
# delete.
|
1604
|
+
# The Amazon Resource Name (ARN) of the project version that you want
|
1605
|
+
# to delete.
|
1550
1606
|
# @return [String]
|
1551
1607
|
#
|
1552
1608
|
class DeleteProjectVersionRequest < Struct.new(
|
@@ -1676,24 +1732,24 @@ module Aws::Rekognition
|
|
1676
1732
|
|
1677
1733
|
# @!attribute [rw] project_arn
|
1678
1734
|
# The Amazon Resource Name (ARN) of the project that contains the
|
1679
|
-
#
|
1735
|
+
# model/adapter you want to describe.
|
1680
1736
|
# @return [String]
|
1681
1737
|
#
|
1682
1738
|
# @!attribute [rw] version_names
|
1683
|
-
# A list of model version names that you want to describe.
|
1684
|
-
# up to 10 model version names to the list. If
|
1685
|
-
#
|
1686
|
-
# of a
|
1687
|
-
# `my-model.2020-01-21T09.10.15` is the version name in the
|
1688
|
-
# ARN.
|
1739
|
+
# A list of model or project version names that you want to describe.
|
1740
|
+
# You can add up to 10 model or project version names to the list. If
|
1741
|
+
# you don't specify a value, all project version descriptions are
|
1742
|
+
# returned. A version name is part of a project version ARN. For
|
1743
|
+
# example, `my-model.2020-01-21T09.10.15` is the version name in the
|
1744
|
+
# following ARN.
|
1689
1745
|
# `arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123`.
|
1690
1746
|
# @return [Array<String>]
|
1691
1747
|
#
|
1692
1748
|
# @!attribute [rw] next_token
|
1693
1749
|
# If the previous response was incomplete (because there is more
|
1694
|
-
# results to retrieve), Amazon Rekognition
|
1695
|
-
#
|
1696
|
-
#
|
1750
|
+
# results to retrieve), Amazon Rekognition returns a pagination token
|
1751
|
+
# in the response. You can use this pagination token to retrieve the
|
1752
|
+
# next set of results.
|
1697
1753
|
# @return [String]
|
1698
1754
|
#
|
1699
1755
|
# @!attribute [rw] max_results
|
@@ -1713,15 +1769,15 @@ module Aws::Rekognition
|
|
1713
1769
|
end
|
1714
1770
|
|
1715
1771
|
# @!attribute [rw] project_version_descriptions
|
1716
|
-
# A list of
|
1717
|
-
# date and time of the
|
1772
|
+
# A list of project version descriptions. The list is sorted by the
|
1773
|
+
# creation date and time of the project versions, latest to earliest.
|
1718
1774
|
# @return [Array<Types::ProjectVersionDescription>]
|
1719
1775
|
#
|
1720
1776
|
# @!attribute [rw] next_token
|
1721
1777
|
# If the previous response was incomplete (because there is more
|
1722
|
-
# results to retrieve), Amazon Rekognition
|
1723
|
-
#
|
1724
|
-
#
|
1778
|
+
# results to retrieve), Amazon Rekognition returns a pagination token
|
1779
|
+
# in the response. You can use this pagination token to retrieve the
|
1780
|
+
# next set of results.
|
1725
1781
|
# @return [String]
|
1726
1782
|
#
|
1727
1783
|
class DescribeProjectVersionsResponse < Struct.new(
|
@@ -1733,9 +1789,9 @@ module Aws::Rekognition
|
|
1733
1789
|
|
1734
1790
|
# @!attribute [rw] next_token
|
1735
1791
|
# If the previous response was incomplete (because there is more
|
1736
|
-
# results to retrieve),
|
1737
|
-
#
|
1738
|
-
#
|
1792
|
+
# results to retrieve), Rekognition returns a pagination token in the
|
1793
|
+
# response. You can use this pagination token to retrieve the next set
|
1794
|
+
# of results.
|
1739
1795
|
# @return [String]
|
1740
1796
|
#
|
1741
1797
|
# @!attribute [rw] max_results
|
@@ -1746,15 +1802,21 @@ module Aws::Rekognition
|
|
1746
1802
|
# @return [Integer]
|
1747
1803
|
#
|
1748
1804
|
# @!attribute [rw] project_names
|
1749
|
-
# A list of the projects that you want
|
1750
|
-
#
|
1751
|
-
#
|
1805
|
+
# A list of the projects that you want Rekognition to describe. If you
|
1806
|
+
# don't specify a value, the response includes descriptions for all
|
1807
|
+
# the projects in your AWS account.
|
1808
|
+
# @return [Array<String>]
|
1809
|
+
#
|
1810
|
+
# @!attribute [rw] features
|
1811
|
+
# Specifies the type of customization to filter projects by. If no
|
1812
|
+
# value is specified, CUSTOM\_LABELS is used as a default.
|
1752
1813
|
# @return [Array<String>]
|
1753
1814
|
#
|
1754
1815
|
class DescribeProjectsRequest < Struct.new(
|
1755
1816
|
:next_token,
|
1756
1817
|
:max_results,
|
1757
|
-
:project_names
|
1818
|
+
:project_names,
|
1819
|
+
:features)
|
1758
1820
|
SENSITIVE = []
|
1759
1821
|
include Aws::Structure
|
1760
1822
|
end
|
@@ -1766,9 +1828,9 @@ module Aws::Rekognition
|
|
1766
1828
|
#
|
1767
1829
|
# @!attribute [rw] next_token
|
1768
1830
|
# If the previous response was incomplete (because there is more
|
1769
|
-
# results to retrieve), Amazon Rekognition
|
1770
|
-
#
|
1771
|
-
#
|
1831
|
+
# results to retrieve), Amazon Rekognition returns a pagination token
|
1832
|
+
# in the response. You can use this pagination token to retrieve the
|
1833
|
+
# next set of results.
|
1772
1834
|
# @return [String]
|
1773
1835
|
#
|
1774
1836
|
class DescribeProjectsResponse < Struct.new(
|
@@ -1888,7 +1950,11 @@ module Aws::Rekognition
|
|
1888
1950
|
end
|
1889
1951
|
|
1890
1952
|
# @!attribute [rw] project_version_arn
|
1891
|
-
# The ARN of the model version that you want to use.
|
1953
|
+
# The ARN of the model version that you want to use. Only models
|
1954
|
+
# associated with Custom Labels projects accepted by the operation. If
|
1955
|
+
# a provided ARN refers to a model version associated with a project
|
1956
|
+
# for a different feature type, then an InvalidParameterException is
|
1957
|
+
# returned.
|
1892
1958
|
# @return [String]
|
1893
1959
|
#
|
1894
1960
|
# @!attribute [rw] image
|
@@ -2287,10 +2353,17 @@ module Aws::Rekognition
|
|
2287
2353
|
# FlowDefinition the image will be sent to.
|
2288
2354
|
# @return [Types::HumanLoopConfig]
|
2289
2355
|
#
|
2356
|
+
# @!attribute [rw] project_version
|
2357
|
+
# Identifier for the custom adapter. Expects the ProjectVersionArn as
|
2358
|
+
# a value. Use the CreateProject or CreateProjectVersion APIs to
|
2359
|
+
# create a custom adapter.
|
2360
|
+
# @return [String]
|
2361
|
+
#
|
2290
2362
|
class DetectModerationLabelsRequest < Struct.new(
|
2291
2363
|
:image,
|
2292
2364
|
:min_confidence,
|
2293
|
-
:human_loop_config
|
2365
|
+
:human_loop_config,
|
2366
|
+
:project_version)
|
2294
2367
|
SENSITIVE = []
|
2295
2368
|
include Aws::Structure
|
2296
2369
|
end
|
@@ -2301,18 +2374,26 @@ module Aws::Rekognition
|
|
2301
2374
|
# @return [Array<Types::ModerationLabel>]
|
2302
2375
|
#
|
2303
2376
|
# @!attribute [rw] moderation_model_version
|
2304
|
-
# Version number of the moderation detection model that was used
|
2305
|
-
# detect unsafe content.
|
2377
|
+
# Version number of the base moderation detection model that was used
|
2378
|
+
# to detect unsafe content.
|
2306
2379
|
# @return [String]
|
2307
2380
|
#
|
2308
2381
|
# @!attribute [rw] human_loop_activation_output
|
2309
2382
|
# Shows the results of the human in the loop evaluation.
|
2310
2383
|
# @return [Types::HumanLoopActivationOutput]
|
2311
2384
|
#
|
2385
|
+
# @!attribute [rw] project_version
|
2386
|
+
# Identifier of the custom adapter that was used during inference. If
|
2387
|
+
# during inference the adapter was EXPIRED, then the parameter will
|
2388
|
+
# not be returned, indicating that a base moderation detection project
|
2389
|
+
# version was used.
|
2390
|
+
# @return [String]
|
2391
|
+
#
|
2312
2392
|
class DetectModerationLabelsResponse < Struct.new(
|
2313
2393
|
:moderation_labels,
|
2314
2394
|
:moderation_model_version,
|
2315
|
-
:human_loop_activation_output
|
2395
|
+
:human_loop_activation_output,
|
2396
|
+
:project_version)
|
2316
2397
|
SENSITIVE = []
|
2317
2398
|
include Aws::Structure
|
2318
2399
|
end
|
@@ -3738,6 +3819,84 @@ module Aws::Rekognition
|
|
3738
3819
|
include Aws::Structure
|
3739
3820
|
end
|
3740
3821
|
|
3822
|
+
# @!attribute [rw] job_id
|
3823
|
+
# Unique identifier for the media analysis job for which you want to
|
3824
|
+
# retrieve results.
|
3825
|
+
# @return [String]
|
3826
|
+
#
|
3827
|
+
class GetMediaAnalysisJobRequest < Struct.new(
|
3828
|
+
:job_id)
|
3829
|
+
SENSITIVE = []
|
3830
|
+
include Aws::Structure
|
3831
|
+
end
|
3832
|
+
|
3833
|
+
# @!attribute [rw] job_id
|
3834
|
+
# The identifier for the media analysis job.
|
3835
|
+
# @return [String]
|
3836
|
+
#
|
3837
|
+
# @!attribute [rw] job_name
|
3838
|
+
# The name of the media analysis job.
|
3839
|
+
# @return [String]
|
3840
|
+
#
|
3841
|
+
# @!attribute [rw] operations_config
|
3842
|
+
# Operation configurations that were provided during job creation.
|
3843
|
+
# @return [Types::MediaAnalysisOperationsConfig]
|
3844
|
+
#
|
3845
|
+
# @!attribute [rw] status
|
3846
|
+
# The current status of the media analysis job.
|
3847
|
+
# @return [String]
|
3848
|
+
#
|
3849
|
+
# @!attribute [rw] failure_details
|
3850
|
+
# Details about the error that resulted in failure of the job.
|
3851
|
+
# @return [Types::MediaAnalysisJobFailureDetails]
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] creation_timestamp
|
3854
|
+
# The Unix date and time when the job was started.
|
3855
|
+
# @return [Time]
|
3856
|
+
#
|
3857
|
+
# @!attribute [rw] completion_timestamp
|
3858
|
+
# The Unix date and time when the job finished.
|
3859
|
+
# @return [Time]
|
3860
|
+
#
|
3861
|
+
# @!attribute [rw] input
|
3862
|
+
# Reference to the input manifest that was provided in the job
|
3863
|
+
# creation request.
|
3864
|
+
# @return [Types::MediaAnalysisInput]
|
3865
|
+
#
|
3866
|
+
# @!attribute [rw] output_config
|
3867
|
+
# Output configuration that was provided in the creation request.
|
3868
|
+
# @return [Types::MediaAnalysisOutputConfig]
|
3869
|
+
#
|
3870
|
+
# @!attribute [rw] kms_key_id
|
3871
|
+
# KMS Key that was provided in the creation request.
|
3872
|
+
# @return [String]
|
3873
|
+
#
|
3874
|
+
# @!attribute [rw] results
|
3875
|
+
# Output manifest that contains prediction results.
|
3876
|
+
# @return [Types::MediaAnalysisResults]
|
3877
|
+
#
|
3878
|
+
# @!attribute [rw] manifest_summary
|
3879
|
+
# The summary manifest provides statistics on input manifest and
|
3880
|
+
# errors identified in the input manifest.
|
3881
|
+
# @return [Types::MediaAnalysisManifestSummary]
|
3882
|
+
#
|
3883
|
+
class GetMediaAnalysisJobResponse < Struct.new(
|
3884
|
+
:job_id,
|
3885
|
+
:job_name,
|
3886
|
+
:operations_config,
|
3887
|
+
:status,
|
3888
|
+
:failure_details,
|
3889
|
+
:creation_timestamp,
|
3890
|
+
:completion_timestamp,
|
3891
|
+
:input,
|
3892
|
+
:output_config,
|
3893
|
+
:kms_key_id,
|
3894
|
+
:results,
|
3895
|
+
:manifest_summary)
|
3896
|
+
SENSITIVE = []
|
3897
|
+
include Aws::Structure
|
3898
|
+
end
|
3899
|
+
|
3741
3900
|
# @!attribute [rw] job_id
|
3742
3901
|
# The identifier for a job that tracks persons in a video. You get the
|
3743
3902
|
# `JobId` from a call to `StartPersonTracking`.
|
@@ -4393,6 +4552,11 @@ module Aws::Rekognition
|
|
4393
4552
|
#
|
4394
4553
|
class InvalidImageFormatException < Aws::EmptyStructure; end
|
4395
4554
|
|
4555
|
+
# Indicates that a provided manifest file is empty or larger than the
|
4556
|
+
# allowed limit.
|
4557
|
+
#
|
4558
|
+
class InvalidManifestException < Aws::EmptyStructure; end
|
4559
|
+
|
4396
4560
|
# Pagination token in the request is not valid.
|
4397
4561
|
#
|
4398
4562
|
class InvalidPaginationTokenException < Aws::EmptyStructure; end
|
@@ -4635,11 +4799,10 @@ module Aws::Rekognition
|
|
4635
4799
|
end
|
4636
4800
|
|
4637
4801
|
# An Amazon Rekognition service limit was exceeded. For example, if you
|
4638
|
-
# start too many
|
4639
|
-
#
|
4640
|
-
#
|
4641
|
-
#
|
4642
|
-
# service limit.
|
4802
|
+
# start too many jobs concurrently, subsequent calls to start operations
|
4803
|
+
# (ex: `StartLabelDetection`) will raise a `LimitExceededException`
|
4804
|
+
# exception (HTTP status code: 400) until the number of concurrently
|
4805
|
+
# running jobs is below the Amazon Rekognition service limit.
|
4643
4806
|
#
|
4644
4807
|
class LimitExceededException < Aws::EmptyStructure; end
|
4645
4808
|
|
@@ -4861,6 +5024,39 @@ module Aws::Rekognition
|
|
4861
5024
|
include Aws::Structure
|
4862
5025
|
end
|
4863
5026
|
|
5027
|
+
# @!attribute [rw] next_token
|
5028
|
+
# Pagination token, if the previous response was incomplete.
|
5029
|
+
# @return [String]
|
5030
|
+
#
|
5031
|
+
# @!attribute [rw] max_results
|
5032
|
+
# The maximum number of results to return per paginated call. The
|
5033
|
+
# largest value user can specify is 100. If user specifies a value
|
5034
|
+
# greater than 100, an `InvalidParameterException` error occurs. The
|
5035
|
+
# default value is 100.
|
5036
|
+
# @return [Integer]
|
5037
|
+
#
|
5038
|
+
class ListMediaAnalysisJobsRequest < Struct.new(
|
5039
|
+
:next_token,
|
5040
|
+
:max_results)
|
5041
|
+
SENSITIVE = []
|
5042
|
+
include Aws::Structure
|
5043
|
+
end
|
5044
|
+
|
5045
|
+
# @!attribute [rw] next_token
|
5046
|
+
# Pagination token, if the previous response was incomplete.
|
5047
|
+
# @return [String]
|
5048
|
+
#
|
5049
|
+
# @!attribute [rw] media_analysis_jobs
|
5050
|
+
# Contains a list of all media analysis jobs.
|
5051
|
+
# @return [Array<Types::MediaAnalysisJobDescription>]
|
5052
|
+
#
|
5053
|
+
class ListMediaAnalysisJobsResponse < Struct.new(
|
5054
|
+
:next_token,
|
5055
|
+
:media_analysis_jobs)
|
5056
|
+
SENSITIVE = []
|
5057
|
+
include Aws::Structure
|
5058
|
+
end
|
5059
|
+
|
4864
5060
|
# @!attribute [rw] project_arn
|
4865
5061
|
# The ARN of the project for which you want to list the project
|
4866
5062
|
# policies.
|
@@ -5042,6 +5238,206 @@ module Aws::Rekognition
|
|
5042
5238
|
include Aws::Structure
|
5043
5239
|
end
|
5044
5240
|
|
5241
|
+
# Configuration for Moderation Labels Detection.
|
5242
|
+
#
|
5243
|
+
# @!attribute [rw] min_confidence
|
5244
|
+
# Specifies the minimum confidence level for the moderation labels to
|
5245
|
+
# return. Amazon Rekognition doesn't return any labels with a
|
5246
|
+
# confidence level lower than this specified value.
|
5247
|
+
# @return [Float]
|
5248
|
+
#
|
5249
|
+
# @!attribute [rw] project_version
|
5250
|
+
# Specifies the custom moderation model to be used during the label
|
5251
|
+
# detection job. If not provided the pre-trained model is used.
|
5252
|
+
# @return [String]
|
5253
|
+
#
|
5254
|
+
class MediaAnalysisDetectModerationLabelsConfig < Struct.new(
|
5255
|
+
:min_confidence,
|
5256
|
+
:project_version)
|
5257
|
+
SENSITIVE = []
|
5258
|
+
include Aws::Structure
|
5259
|
+
end
|
5260
|
+
|
5261
|
+
# Contains input information for a media analysis job.
|
5262
|
+
#
|
5263
|
+
# @!attribute [rw] s3_object
|
5264
|
+
# Provides the S3 bucket name and object name.
|
5265
|
+
#
|
5266
|
+
# The region for the S3 bucket containing the S3 object must match the
|
5267
|
+
# region you use for Amazon Rekognition operations.
|
5268
|
+
#
|
5269
|
+
# For Amazon Rekognition to process an S3 object, the user must have
|
5270
|
+
# permission to access the S3 object. For more information, see How
|
5271
|
+
# Amazon Rekognition works with IAM in the Amazon Rekognition
|
5272
|
+
# Developer Guide.
|
5273
|
+
# @return [Types::S3Object]
|
5274
|
+
#
|
5275
|
+
class MediaAnalysisInput < Struct.new(
|
5276
|
+
:s3_object)
|
5277
|
+
SENSITIVE = []
|
5278
|
+
include Aws::Structure
|
5279
|
+
end
|
5280
|
+
|
5281
|
+
# Description for a media analysis job.
|
5282
|
+
#
|
5283
|
+
# @!attribute [rw] job_id
|
5284
|
+
# The identifier for a media analysis job.
|
5285
|
+
# @return [String]
|
5286
|
+
#
|
5287
|
+
# @!attribute [rw] job_name
|
5288
|
+
# The name of a media analysis job.
|
5289
|
+
# @return [String]
|
5290
|
+
#
|
5291
|
+
# @!attribute [rw] operations_config
|
5292
|
+
# Operation configurations that were provided during job creation.
|
5293
|
+
# @return [Types::MediaAnalysisOperationsConfig]
|
5294
|
+
#
|
5295
|
+
# @!attribute [rw] status
|
5296
|
+
# The status of the media analysis job being retrieved.
|
5297
|
+
# @return [String]
|
5298
|
+
#
|
5299
|
+
# @!attribute [rw] failure_details
|
5300
|
+
# Details about the error that resulted in failure of the job.
|
5301
|
+
# @return [Types::MediaAnalysisJobFailureDetails]
|
5302
|
+
#
|
5303
|
+
# @!attribute [rw] creation_timestamp
|
5304
|
+
# The Unix date and time when the job was started.
|
5305
|
+
# @return [Time]
|
5306
|
+
#
|
5307
|
+
# @!attribute [rw] completion_timestamp
|
5308
|
+
# The Unix date and time when the job finished.
|
5309
|
+
# @return [Time]
|
5310
|
+
#
|
5311
|
+
# @!attribute [rw] input
|
5312
|
+
# Reference to the input manifest that was provided in the job
|
5313
|
+
# creation request.
|
5314
|
+
# @return [Types::MediaAnalysisInput]
|
5315
|
+
#
|
5316
|
+
# @!attribute [rw] output_config
|
5317
|
+
# Output configuration that was provided in the creation request.
|
5318
|
+
# @return [Types::MediaAnalysisOutputConfig]
|
5319
|
+
#
|
5320
|
+
# @!attribute [rw] kms_key_id
|
5321
|
+
# KMS Key that was provided in the creation request.
|
5322
|
+
# @return [String]
|
5323
|
+
#
|
5324
|
+
# @!attribute [rw] results
|
5325
|
+
# Output manifest that contains prediction results.
|
5326
|
+
# @return [Types::MediaAnalysisResults]
|
5327
|
+
#
|
5328
|
+
# @!attribute [rw] manifest_summary
|
5329
|
+
# Provides statistics on input manifest and errors identified in the
|
5330
|
+
# input manifest.
|
5331
|
+
# @return [Types::MediaAnalysisManifestSummary]
|
5332
|
+
#
|
5333
|
+
class MediaAnalysisJobDescription < Struct.new(
|
5334
|
+
:job_id,
|
5335
|
+
:job_name,
|
5336
|
+
:operations_config,
|
5337
|
+
:status,
|
5338
|
+
:failure_details,
|
5339
|
+
:creation_timestamp,
|
5340
|
+
:completion_timestamp,
|
5341
|
+
:input,
|
5342
|
+
:output_config,
|
5343
|
+
:kms_key_id,
|
5344
|
+
:results,
|
5345
|
+
:manifest_summary)
|
5346
|
+
SENSITIVE = []
|
5347
|
+
include Aws::Structure
|
5348
|
+
end
|
5349
|
+
|
5350
|
+
# Details about the error that resulted in failure of the job.
|
5351
|
+
#
|
5352
|
+
# @!attribute [rw] code
|
5353
|
+
# Error code for the failed job.
|
5354
|
+
# @return [String]
|
5355
|
+
#
|
5356
|
+
# @!attribute [rw] message
|
5357
|
+
# Human readable error message.
|
5358
|
+
# @return [String]
|
5359
|
+
#
|
5360
|
+
class MediaAnalysisJobFailureDetails < Struct.new(
|
5361
|
+
:code,
|
5362
|
+
:message)
|
5363
|
+
SENSITIVE = []
|
5364
|
+
include Aws::Structure
|
5365
|
+
end
|
5366
|
+
|
5367
|
+
# Summary that provides statistics on input manifest and errors
|
5368
|
+
# identified in the input manifest.
|
5369
|
+
#
|
5370
|
+
# @!attribute [rw] s3_object
|
5371
|
+
# Provides the S3 bucket name and object name.
|
5372
|
+
#
|
5373
|
+
# The region for the S3 bucket containing the S3 object must match the
|
5374
|
+
# region you use for Amazon Rekognition operations.
|
5375
|
+
#
|
5376
|
+
# For Amazon Rekognition to process an S3 object, the user must have
|
5377
|
+
# permission to access the S3 object. For more information, see How
|
5378
|
+
# Amazon Rekognition works with IAM in the Amazon Rekognition
|
5379
|
+
# Developer Guide.
|
5380
|
+
# @return [Types::S3Object]
|
5381
|
+
#
|
5382
|
+
class MediaAnalysisManifestSummary < Struct.new(
|
5383
|
+
:s3_object)
|
5384
|
+
SENSITIVE = []
|
5385
|
+
include Aws::Structure
|
5386
|
+
end
|
5387
|
+
|
5388
|
+
# Configuration options for a media analysis job. Configuration is
|
5389
|
+
# operation-specific.
|
5390
|
+
#
|
5391
|
+
# @!attribute [rw] detect_moderation_labels
|
5392
|
+
# Contains configuration options for a DetectModerationLabels job.
|
5393
|
+
# @return [Types::MediaAnalysisDetectModerationLabelsConfig]
|
5394
|
+
#
|
5395
|
+
class MediaAnalysisOperationsConfig < Struct.new(
|
5396
|
+
:detect_moderation_labels)
|
5397
|
+
SENSITIVE = []
|
5398
|
+
include Aws::Structure
|
5399
|
+
end
|
5400
|
+
|
5401
|
+
# Output configuration provided in the job creation request.
|
5402
|
+
#
|
5403
|
+
# @!attribute [rw] s3_bucket
|
5404
|
+
# Specifies the Amazon S3 bucket to contain the output of the media
|
5405
|
+
# analysis job.
|
5406
|
+
# @return [String]
|
5407
|
+
#
|
5408
|
+
# @!attribute [rw] s3_key_prefix
|
5409
|
+
# Specifies the Amazon S3 key prefix that comes after the name of the
|
5410
|
+
# bucket you have designated for storage.
|
5411
|
+
# @return [String]
|
5412
|
+
#
|
5413
|
+
class MediaAnalysisOutputConfig < Struct.new(
|
5414
|
+
:s3_bucket,
|
5415
|
+
:s3_key_prefix)
|
5416
|
+
SENSITIVE = []
|
5417
|
+
include Aws::Structure
|
5418
|
+
end
|
5419
|
+
|
5420
|
+
# Contains the results for a media analysis job created with
|
5421
|
+
# StartMediaAnalysisJob.
|
5422
|
+
#
|
5423
|
+
# @!attribute [rw] s3_object
|
5424
|
+
# Provides the S3 bucket name and object name.
|
5425
|
+
#
|
5426
|
+
# The region for the S3 bucket containing the S3 object must match the
|
5427
|
+
# region you use for Amazon Rekognition operations.
|
5428
|
+
#
|
5429
|
+
# For Amazon Rekognition to process an S3 object, the user must have
|
5430
|
+
# permission to access the S3 object. For more information, see How
|
5431
|
+
# Amazon Rekognition works with IAM in the Amazon Rekognition
|
5432
|
+
# Developer Guide.
|
5433
|
+
# @return [Types::S3Object]
|
5434
|
+
#
|
5435
|
+
class MediaAnalysisResults < Struct.new(
|
5436
|
+
:s3_object)
|
5437
|
+
SENSITIVE = []
|
5438
|
+
include Aws::Structure
|
5439
|
+
end
|
5440
|
+
|
5045
5441
|
# Provides information about a single type of inappropriate, unwanted,
|
5046
5442
|
# or offensive content found in an image or video. Each type of
|
5047
5443
|
# moderated content has a label within a hierarchical taxonomy. For more
|
@@ -5319,11 +5715,22 @@ module Aws::Rekognition
|
|
5319
5715
|
# Information about the training and test datasets in the project.
|
5320
5716
|
# @return [Array<Types::DatasetMetadata>]
|
5321
5717
|
#
|
5718
|
+
# @!attribute [rw] feature
|
5719
|
+
# Specifies the project that is being customized.
|
5720
|
+
# @return [String]
|
5721
|
+
#
|
5722
|
+
# @!attribute [rw] auto_update
|
5723
|
+
# Indicates whether automatic retraining will be attempted for the
|
5724
|
+
# versions of the project. Applies only to adapters.
|
5725
|
+
# @return [String]
|
5726
|
+
#
|
5322
5727
|
class ProjectDescription < Struct.new(
|
5323
5728
|
:project_arn,
|
5324
5729
|
:creation_timestamp,
|
5325
5730
|
:status,
|
5326
|
-
:datasets
|
5731
|
+
:datasets,
|
5732
|
+
:feature,
|
5733
|
+
:auto_update)
|
5327
5734
|
SENSITIVE = []
|
5328
5735
|
include Aws::Structure
|
5329
5736
|
end
|
@@ -5366,11 +5773,10 @@ module Aws::Rekognition
|
|
5366
5773
|
include Aws::Structure
|
5367
5774
|
end
|
5368
5775
|
|
5369
|
-
# A description of a version of
|
5370
|
-
# model.
|
5776
|
+
# A description of a version of a Amazon Rekognition project version.
|
5371
5777
|
#
|
5372
5778
|
# @!attribute [rw] project_version_arn
|
5373
|
-
# The Amazon Resource Name (ARN) of the
|
5779
|
+
# The Amazon Resource Name (ARN) of the project version.
|
5374
5780
|
# @return [String]
|
5375
5781
|
#
|
5376
5782
|
# @!attribute [rw] creation_timestamp
|
@@ -5378,8 +5784,9 @@ module Aws::Rekognition
|
|
5378
5784
|
# @return [Time]
|
5379
5785
|
#
|
5380
5786
|
# @!attribute [rw] min_inference_units
|
5381
|
-
# The minimum number of inference units used by the model.
|
5382
|
-
# information, see
|
5787
|
+
# The minimum number of inference units used by the model. Applies
|
5788
|
+
# only to Custom Labels projects. For more information, see
|
5789
|
+
# StartProjectVersion.
|
5383
5790
|
# @return [Integer]
|
5384
5791
|
#
|
5385
5792
|
# @!attribute [rw] status
|
@@ -5429,9 +5836,9 @@ module Aws::Rekognition
|
|
5429
5836
|
# @return [String]
|
5430
5837
|
#
|
5431
5838
|
# @!attribute [rw] max_inference_units
|
5432
|
-
# The maximum number of inference units Amazon Rekognition
|
5433
|
-
#
|
5434
|
-
# StartProjectVersion.
|
5839
|
+
# The maximum number of inference units Amazon Rekognition uses to
|
5840
|
+
# auto-scale the model. Applies only to Custom Labels projects. For
|
5841
|
+
# more information, see StartProjectVersion.
|
5435
5842
|
# @return [Integer]
|
5436
5843
|
#
|
5437
5844
|
# @!attribute [rw] source_project_version_arn
|
@@ -5440,6 +5847,22 @@ module Aws::Rekognition
|
|
5440
5847
|
# version.
|
5441
5848
|
# @return [String]
|
5442
5849
|
#
|
5850
|
+
# @!attribute [rw] version_description
|
5851
|
+
# A user-provided description of the project version.
|
5852
|
+
# @return [String]
|
5853
|
+
#
|
5854
|
+
# @!attribute [rw] feature
|
5855
|
+
# The feature that was customized.
|
5856
|
+
# @return [String]
|
5857
|
+
#
|
5858
|
+
# @!attribute [rw] base_model_version
|
5859
|
+
# The base detection model version used to create the project version.
|
5860
|
+
# @return [String]
|
5861
|
+
#
|
5862
|
+
# @!attribute [rw] feature_config
|
5863
|
+
# Feature specific configuration that was applied during training.
|
5864
|
+
# @return [Types::CustomizationFeatureConfig]
|
5865
|
+
#
|
5443
5866
|
class ProjectVersionDescription < Struct.new(
|
5444
5867
|
:project_version_arn,
|
5445
5868
|
:creation_timestamp,
|
@@ -5455,7 +5878,11 @@ module Aws::Rekognition
|
|
5455
5878
|
:manifest_summary,
|
5456
5879
|
:kms_key_id,
|
5457
5880
|
:max_inference_units,
|
5458
|
-
:source_project_version_arn
|
5881
|
+
:source_project_version_arn,
|
5882
|
+
:version_description,
|
5883
|
+
:feature,
|
5884
|
+
:base_model_version,
|
5885
|
+
:feature_config)
|
5459
5886
|
SENSITIVE = []
|
5460
5887
|
include Aws::Structure
|
5461
5888
|
end
|
@@ -6616,6 +7043,61 @@ module Aws::Rekognition
|
|
6616
7043
|
include Aws::Structure
|
6617
7044
|
end
|
6618
7045
|
|
7046
|
+
# @!attribute [rw] client_request_token
|
7047
|
+
# Idempotency token used to prevent the accidental creation of
|
7048
|
+
# duplicate versions. If you use the same token with multiple
|
7049
|
+
# `StartMediaAnalysisJobRequest` requests, the same response is
|
7050
|
+
# returned. Use `ClientRequestToken` to prevent the same request from
|
7051
|
+
# being processed more than once.
|
7052
|
+
#
|
7053
|
+
# **A suitable default value is auto-generated.** You should normally
|
7054
|
+
# not need to pass this option.
|
7055
|
+
# @return [String]
|
7056
|
+
#
|
7057
|
+
# @!attribute [rw] job_name
|
7058
|
+
# The name of the job. Does not have to be unique.
|
7059
|
+
# @return [String]
|
7060
|
+
#
|
7061
|
+
# @!attribute [rw] operations_config
|
7062
|
+
# Configuration options for the media analysis job to be created.
|
7063
|
+
# @return [Types::MediaAnalysisOperationsConfig]
|
7064
|
+
#
|
7065
|
+
# @!attribute [rw] input
|
7066
|
+
# Input data to be analyzed by the job.
|
7067
|
+
# @return [Types::MediaAnalysisInput]
|
7068
|
+
#
|
7069
|
+
# @!attribute [rw] output_config
|
7070
|
+
# The Amazon S3 bucket location to store the results.
|
7071
|
+
# @return [Types::MediaAnalysisOutputConfig]
|
7072
|
+
#
|
7073
|
+
# @!attribute [rw] kms_key_id
|
7074
|
+
# The identifier of customer managed AWS KMS key (name or ARN). The
|
7075
|
+
# key is used to encrypt images copied into the service. The key is
|
7076
|
+
# also used to encrypt results and manifest files written to the
|
7077
|
+
# output Amazon S3 bucket.
|
7078
|
+
# @return [String]
|
7079
|
+
#
|
7080
|
+
class StartMediaAnalysisJobRequest < Struct.new(
|
7081
|
+
:client_request_token,
|
7082
|
+
:job_name,
|
7083
|
+
:operations_config,
|
7084
|
+
:input,
|
7085
|
+
:output_config,
|
7086
|
+
:kms_key_id)
|
7087
|
+
SENSITIVE = []
|
7088
|
+
include Aws::Structure
|
7089
|
+
end
|
7090
|
+
|
7091
|
+
# @!attribute [rw] job_id
|
7092
|
+
# Identifier for the created job.
|
7093
|
+
# @return [String]
|
7094
|
+
#
|
7095
|
+
class StartMediaAnalysisJobResponse < Struct.new(
|
7096
|
+
:job_id)
|
7097
|
+
SENSITIVE = []
|
7098
|
+
include Aws::Structure
|
7099
|
+
end
|
7100
|
+
|
6619
7101
|
# @!attribute [rw] video
|
6620
7102
|
# The video in which you want to detect people. The video must be
|
6621
7103
|
# stored in an Amazon S3 bucket.
|
@@ -6672,11 +7154,6 @@ module Aws::Rekognition
|
|
6672
7154
|
# The minimum number of inference units to use. A single inference
|
6673
7155
|
# unit represents 1 hour of processing.
|
6674
7156
|
#
|
6675
|
-
# For information about the number of transactions per second (TPS)
|
6676
|
-
# that an inference unit can support, see *Running a trained Amazon
|
6677
|
-
# Rekognition Custom Labels model* in the Amazon Rekognition Custom
|
6678
|
-
# Labels Guide.
|
6679
|
-
#
|
6680
7157
|
# Use a higher number to increase the TPS throughput of your model.
|
6681
7158
|
# You are charged for the number of inference units that you use.
|
6682
7159
|
# @return [Integer]
|
@@ -6969,7 +7446,7 @@ module Aws::Rekognition
|
|
6969
7446
|
|
6970
7447
|
# @!attribute [rw] project_version_arn
|
6971
7448
|
# The Amazon Resource Name (ARN) of the model version that you want to
|
6972
|
-
#
|
7449
|
+
# stop.
|
6973
7450
|
#
|
6974
7451
|
# This operation requires permissions to perform the
|
6975
7452
|
# `rekognition:StopProjectVersion` action.
|
@@ -7259,18 +7736,16 @@ module Aws::Rekognition
|
|
7259
7736
|
end
|
7260
7737
|
|
7261
7738
|
# The dataset used for testing. Optionally, if `AutoCreate` is set,
|
7262
|
-
# Amazon Rekognition
|
7263
|
-
#
|
7739
|
+
# Amazon Rekognition uses the training dataset to create a test dataset
|
7740
|
+
# with a temporary split of the training dataset.
|
7264
7741
|
#
|
7265
7742
|
# @!attribute [rw] assets
|
7266
7743
|
# The assets used for testing.
|
7267
7744
|
# @return [Array<Types::Asset>]
|
7268
7745
|
#
|
7269
7746
|
# @!attribute [rw] auto_create
|
7270
|
-
# If specified,
|
7271
|
-
#
|
7272
|
-
# training job. After training completes, the test dataset is not
|
7273
|
-
# stored and the training dataset reverts to its previous size.
|
7747
|
+
# If specified, Rekognition splits training dataset to create a test
|
7748
|
+
# dataset for the training job.
|
7274
7749
|
# @return [Boolean]
|
7275
7750
|
#
|
7276
7751
|
class TestingData < Struct.new(
|
@@ -7390,8 +7865,8 @@ module Aws::Rekognition
|
|
7390
7865
|
# The dataset used for training.
|
7391
7866
|
#
|
7392
7867
|
# @!attribute [rw] assets
|
7393
|
-
# A
|
7394
|
-
#
|
7868
|
+
# A manifest file that contains references to the training images and
|
7869
|
+
# ground-truth annotations.
|
7395
7870
|
# @return [Array<Types::Asset>]
|
7396
7871
|
#
|
7397
7872
|
class TrainingData < Struct.new(
|
@@ -7400,21 +7875,21 @@ module Aws::Rekognition
|
|
7400
7875
|
include Aws::Structure
|
7401
7876
|
end
|
7402
7877
|
|
7403
|
-
#
|
7404
|
-
#
|
7878
|
+
# The data validation manifest created for the training dataset during
|
7879
|
+
# model training.
|
7405
7880
|
#
|
7406
7881
|
# @!attribute [rw] input
|
7407
|
-
# The training
|
7882
|
+
# The training data that you supplied.
|
7408
7883
|
# @return [Types::TrainingData]
|
7409
7884
|
#
|
7410
7885
|
# @!attribute [rw] output
|
7411
|
-
#
|
7412
|
-
#
|
7886
|
+
# Reference to images (assets) that were actually used during training
|
7887
|
+
# with trained model predictions.
|
7413
7888
|
# @return [Types::TrainingData]
|
7414
7889
|
#
|
7415
7890
|
# @!attribute [rw] validation
|
7416
|
-
#
|
7417
|
-
#
|
7891
|
+
# A manifest that you supplied for training, with validation results
|
7892
|
+
# for each line.
|
7418
7893
|
# @return [Types::ValidationData]
|
7419
7894
|
#
|
7420
7895
|
class TrainingDataResult < Struct.new(
|