aws-sdk-rekognition 1.66.0 → 1.69.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -791,7 +791,7 @@ module Aws::Rekognition
791
791
  # project. For more information, see Creating training and test dataset
792
792
  # in the *Amazon Rekognition Custom Labels Developer Guide*.
793
793
  #
794
- # <note markdown="1"> You can train a modelin a project that doesn't have associated
794
+ # <note markdown="1"> You can train a model in a project that doesn't have associated
795
795
  # datasets by specifying manifest files in the `TrainingData` and
796
796
  # `TestingData` fields.
797
797
  #
@@ -930,23 +930,36 @@ module Aws::Rekognition
930
930
  end
931
931
 
932
932
  # Creates an Amazon Rekognition stream processor that you can use to
933
- # detect and recognize faces in a streaming video.
933
+ # detect and recognize faces or to detect labels in a streaming video.
934
934
  #
935
935
  # Amazon Rekognition Video is a consumer of live video from Amazon
936
- # Kinesis Video Streams. Amazon Rekognition Video sends analysis results
937
- # to Amazon Kinesis Data Streams.
938
- #
939
- # You provide as input a Kinesis video stream (`Input`) and a Kinesis
940
- # data stream (`Output`) stream. You also specify the face recognition
941
- # criteria in `Settings`. For example, the collection containing faces
942
- # that you want to recognize. Use `Name` to assign an identifier for the
943
- # stream processor. You use `Name` to manage the stream processor. For
944
- # example, you can start processing the source video by calling
945
- # StartStreamProcessor with the `Name` field.
946
- #
947
- # After you have finished analyzing a streaming video, use
948
- # StopStreamProcessor to stop processing. You can delete the stream
949
- # processor by calling DeleteStreamProcessor.
936
+ # Kinesis Video Streams. There are two different settings for stream
937
+ # processors in Amazon Rekognition: detecting faces and detecting
938
+ # labels.
939
+ #
940
+ # * If you are creating a stream processor for detecting faces, you
941
+ # provide as input a Kinesis video stream (`Input`) and a Kinesis data
942
+ # stream (`Output`) stream. You also specify the face recognition
943
+ # criteria in `Settings`. For example, the collection containing faces
944
+ # that you want to recognize. After you have finished analyzing a
945
+ # streaming video, use StopStreamProcessor to stop processing.
946
+ #
947
+ # * If you are creating a stream processor to detect labels, you provide
948
+ # as input a Kinesis video stream (`Input`), Amazon S3 bucket
949
+ # information (`Output`), and an Amazon SNS topic ARN
950
+ # (`NotificationChannel`). You can also provide a KMS key ID to
951
+ # encrypt the data sent to your Amazon S3 bucket. You specify what you
952
+ # want to detect in `ConnectedHomeSettings`, such as people, packages
953
+ # and people, or pets, people, and packages. You can also specify
954
+ # where in the frame you want Amazon Rekognition to monitor with
955
+ # `RegionsOfInterest`. When you run the StartStreamProcessor operation
956
+ # on a label detection stream processor, you input start and stop
957
+ # information to determine the length of the processing time.
958
+ #
959
+ # Use `Name` to assign an identifier for the stream processor. You use
960
+ # `Name` to manage the stream processor. For example, you can start
961
+ # processing the source video by calling StartStreamProcessor with the
962
+ # `Name` field.
950
963
  #
951
964
  # This operation requires permissions to perform the
952
965
  # `rekognition:CreateStreamProcessor` action. If you want to tag your
@@ -956,31 +969,79 @@ module Aws::Rekognition
956
969
  # @option params [required, Types::StreamProcessorInput] :input
957
970
  # Kinesis video stream stream that provides the source streaming video.
958
971
  # If you are using the AWS CLI, the parameter name is
959
- # `StreamProcessorInput`.
972
+ # `StreamProcessorInput`. This is required for both face search and
973
+ # label detection stream processors.
960
974
  #
961
975
  # @option params [required, Types::StreamProcessorOutput] :output
962
- # Kinesis data stream stream to which Amazon Rekognition Video puts the
963
- # analysis results. If you are using the AWS CLI, the parameter name is
964
- # `StreamProcessorOutput`.
976
+ # Kinesis data stream stream or Amazon S3 bucket location to which
977
+ # Amazon Rekognition Video puts the analysis results. If you are using
978
+ # the AWS CLI, the parameter name is `StreamProcessorOutput`. This must
979
+ # be a S3Destination of an Amazon S3 bucket that you own for a label
980
+ # detection stream processor or a Kinesis data stream ARN for a face
981
+ # search stream processor.
965
982
  #
966
983
  # @option params [required, String] :name
967
984
  # An identifier you assign to the stream processor. You can use `Name`
968
985
  # to manage the stream processor. For example, you can get the current
969
986
  # status of the stream processor by calling DescribeStreamProcessor.
970
- # `Name` is idempotent.
987
+ # `Name` is idempotent. This is required for both face search and label
988
+ # detection stream processors.
971
989
  #
972
990
  # @option params [required, Types::StreamProcessorSettings] :settings
973
- # Face recognition input parameters to be used by the stream processor.
974
- # Includes the collection to use for face recognition and the face
975
- # attributes to detect.
991
+ # Input parameters used in a streaming video analyzed by a stream
992
+ # processor. You can use `FaceSearch` to recognize faces in a streaming
993
+ # video, or you can use `ConnectedHome` to detect labels.
976
994
  #
977
995
  # @option params [required, String] :role_arn
978
- # ARN of the IAM role that allows access to the stream processor.
996
+ # The Amazon Resource Number (ARN) of the IAM role that allows access to
997
+ # the stream processor. The IAM role provides Rekognition read
998
+ # permissions for a Kinesis stream. It also provides write permissions
999
+ # to an Amazon S3 bucket and Amazon Simple Notification Service topic
1000
+ # for a label detection stream processor. This is required for both face
1001
+ # search and label detection stream processors.
979
1002
  #
980
1003
  # @option params [Hash<String,String>] :tags
981
1004
  # A set of tags (key-value pairs) that you want to attach to the stream
982
1005
  # processor.
983
1006
  #
1007
+ # @option params [Types::StreamProcessorNotificationChannel] :notification_channel
1008
+ # The Amazon Simple Notification Service topic to which Amazon
1009
+ # Rekognition publishes the object detection results and completion
1010
+ # status of a video analysis operation.
1011
+ #
1012
+ # Amazon Rekognition publishes a notification the first time an object
1013
+ # of interest or a person is detected in the video stream. For example,
1014
+ # if Amazon Rekognition detects a person at second 2, a pet at second 4,
1015
+ # and a person again at second 5, Amazon Rekognition sends 2 object
1016
+ # class detected notifications, one for a person at second 2 and one for
1017
+ # a pet at second 4.
1018
+ #
1019
+ # Amazon Rekognition also publishes an an end-of-session notification
1020
+ # with a summary when the stream processing session is complete.
1021
+ #
1022
+ # @option params [String] :kms_key_id
1023
+ # The identifier for your AWS Key Management Service key (AWS KMS key).
1024
+ # This is an optional parameter for label detection stream processors
1025
+ # and should not be used to create a face search stream processor. You
1026
+ # can supply the Amazon Resource Name (ARN) of your KMS key, the ID of
1027
+ # your KMS key, an alias for your KMS key, or an alias ARN. The key is
1028
+ # used to encrypt results and data published to your Amazon S3 bucket,
1029
+ # which includes image frames and hero images. Your source images are
1030
+ # unaffected.
1031
+ #
1032
+ # @option params [Array<Types::RegionOfInterest>] :regions_of_interest
1033
+ # Specifies locations in the frames where Amazon Rekognition checks for
1034
+ # objects or people. You can specify up to 10 regions of interest, and
1035
+ # each region has either a polygon or a bounding box. This is an
1036
+ # optional parameter for label detection stream processors and should
1037
+ # not be used to create a face search stream processor.
1038
+ #
1039
+ # @option params [Types::StreamProcessorDataSharingPreference] :data_sharing_preference
1040
+ # Shows whether you are sharing data with Rekognition to improve model
1041
+ # performance. You can choose this option at the account level or on a
1042
+ # per-stream basis. Note that if you opt out at the account level this
1043
+ # setting is ignored on individual streams.
1044
+ #
984
1045
  # @return [Types::CreateStreamProcessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
985
1046
  #
986
1047
  # * {Types::CreateStreamProcessorResponse#stream_processor_arn #stream_processor_arn} => String
@@ -997,6 +1058,10 @@ module Aws::Rekognition
997
1058
  # kinesis_data_stream: {
998
1059
  # arn: "KinesisDataArn",
999
1060
  # },
1061
+ # s3_destination: {
1062
+ # bucket: "S3Bucket",
1063
+ # key_prefix: "S3KeyPrefix",
1064
+ # },
1000
1065
  # },
1001
1066
  # name: "StreamProcessorName", # required
1002
1067
  # settings: { # required
@@ -1004,11 +1069,38 @@ module Aws::Rekognition
1004
1069
  # collection_id: "CollectionId",
1005
1070
  # face_match_threshold: 1.0,
1006
1071
  # },
1072
+ # connected_home: {
1073
+ # labels: ["ConnectedHomeLabel"], # required
1074
+ # min_confidence: 1.0,
1075
+ # },
1007
1076
  # },
1008
1077
  # role_arn: "RoleArn", # required
1009
1078
  # tags: {
1010
1079
  # "TagKey" => "TagValue",
1011
1080
  # },
1081
+ # notification_channel: {
1082
+ # sns_topic_arn: "SNSTopicArn", # required
1083
+ # },
1084
+ # kms_key_id: "KmsKeyId",
1085
+ # regions_of_interest: [
1086
+ # {
1087
+ # bounding_box: {
1088
+ # width: 1.0,
1089
+ # height: 1.0,
1090
+ # left: 1.0,
1091
+ # top: 1.0,
1092
+ # },
1093
+ # polygon: [
1094
+ # {
1095
+ # x: 1.0,
1096
+ # y: 1.0,
1097
+ # },
1098
+ # ],
1099
+ # },
1100
+ # ],
1101
+ # data_sharing_preference: {
1102
+ # opt_in: false, # required
1103
+ # },
1012
1104
  # })
1013
1105
  #
1014
1106
  # @example Response structure
@@ -1023,12 +1115,16 @@ module Aws::Rekognition
1023
1115
  end
1024
1116
 
1025
1117
  # Deletes the specified collection. Note that this operation removes all
1026
- # faces in the collection. For an example, see
1027
- # delete-collection-procedure.
1118
+ # faces in the collection. For an example, see [Deleting a
1119
+ # collection][1].
1028
1120
  #
1029
1121
  # This operation requires permissions to perform the
1030
1122
  # `rekognition:DeleteCollection` action.
1031
1123
  #
1124
+ #
1125
+ #
1126
+ # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html
1127
+ #
1032
1128
  # @option params [required, String] :collection_id
1033
1129
  # ID of the collection to delete.
1034
1130
  #
@@ -1420,6 +1516,7 @@ module Aws::Rekognition
1420
1516
  # resp.project_version_descriptions[0].manifest_summary.s3_object.name #=> String
1421
1517
  # resp.project_version_descriptions[0].manifest_summary.s3_object.version #=> String
1422
1518
  # resp.project_version_descriptions[0].kms_key_id #=> String
1519
+ # resp.project_version_descriptions[0].max_inference_units #=> Integer
1423
1520
  # resp.next_token #=> String
1424
1521
  #
1425
1522
  #
@@ -1514,6 +1611,10 @@ module Aws::Rekognition
1514
1611
  # * {Types::DescribeStreamProcessorResponse#output #output} => Types::StreamProcessorOutput
1515
1612
  # * {Types::DescribeStreamProcessorResponse#role_arn #role_arn} => String
1516
1613
  # * {Types::DescribeStreamProcessorResponse#settings #settings} => Types::StreamProcessorSettings
1614
+ # * {Types::DescribeStreamProcessorResponse#notification_channel #notification_channel} => Types::StreamProcessorNotificationChannel
1615
+ # * {Types::DescribeStreamProcessorResponse#kms_key_id #kms_key_id} => String
1616
+ # * {Types::DescribeStreamProcessorResponse#regions_of_interest #regions_of_interest} => Array&lt;Types::RegionOfInterest&gt;
1617
+ # * {Types::DescribeStreamProcessorResponse#data_sharing_preference #data_sharing_preference} => Types::StreamProcessorDataSharingPreference
1517
1618
  #
1518
1619
  # @example Request syntax with placeholder values
1519
1620
  #
@@ -1525,15 +1626,31 @@ module Aws::Rekognition
1525
1626
  #
1526
1627
  # resp.name #=> String
1527
1628
  # resp.stream_processor_arn #=> String
1528
- # resp.status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING"
1629
+ # resp.status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING", "UPDATING"
1529
1630
  # resp.status_message #=> String
1530
1631
  # resp.creation_timestamp #=> Time
1531
1632
  # resp.last_update_timestamp #=> Time
1532
1633
  # resp.input.kinesis_video_stream.arn #=> String
1533
1634
  # resp.output.kinesis_data_stream.arn #=> String
1635
+ # resp.output.s3_destination.bucket #=> String
1636
+ # resp.output.s3_destination.key_prefix #=> String
1534
1637
  # resp.role_arn #=> String
1535
1638
  # resp.settings.face_search.collection_id #=> String
1536
1639
  # resp.settings.face_search.face_match_threshold #=> Float
1640
+ # resp.settings.connected_home.labels #=> Array
1641
+ # resp.settings.connected_home.labels[0] #=> String
1642
+ # resp.settings.connected_home.min_confidence #=> Float
1643
+ # resp.notification_channel.sns_topic_arn #=> String
1644
+ # resp.kms_key_id #=> String
1645
+ # resp.regions_of_interest #=> Array
1646
+ # resp.regions_of_interest[0].bounding_box.width #=> Float
1647
+ # resp.regions_of_interest[0].bounding_box.height #=> Float
1648
+ # resp.regions_of_interest[0].bounding_box.left #=> Float
1649
+ # resp.regions_of_interest[0].bounding_box.top #=> Float
1650
+ # resp.regions_of_interest[0].polygon #=> Array
1651
+ # resp.regions_of_interest[0].polygon[0].x #=> Float
1652
+ # resp.regions_of_interest[0].polygon[0].y #=> Float
1653
+ # resp.data_sharing_preference.opt_in #=> Boolean
1537
1654
  #
1538
1655
  # @overload describe_stream_processor(params = {})
1539
1656
  # @param [Hash] params ({})
@@ -1616,8 +1733,9 @@ module Aws::Rekognition
1616
1733
  # using the S3Object property.
1617
1734
  #
1618
1735
  # For Amazon Rekognition to process an S3 object, the user must have
1619
- # permission to access the S3 object. For more information, see Resource
1620
- # Based Policies in the Amazon Rekognition Developer Guide.
1736
+ # permission to access the S3 object. For more information, see How
1737
+ # Amazon Rekognition works with IAM in the Amazon Rekognition Developer
1738
+ # Guide.
1621
1739
  #
1622
1740
  # @option params [Integer] :max_results
1623
1741
  # Maximum number of results you want the service to return in the
@@ -1859,7 +1977,7 @@ module Aws::Rekognition
1859
1977
  # events like wedding, graduation, and birthday party; and concepts like
1860
1978
  # landscape, evening, and nature.
1861
1979
  #
1862
- # For an example, see Analyzing Images Stored in an Amazon S3 Bucket in
1980
+ # For an example, see Analyzing images stored in an Amazon S3 bucket in
1863
1981
  # the Amazon Rekognition Developer Guide.
1864
1982
  #
1865
1983
  # <note markdown="1"> `DetectLabels` does not support the detection of activities. However,
@@ -2256,7 +2374,7 @@ module Aws::Rekognition
2256
2374
  # To be detected, text must be within +/- 90 degrees orientation of the
2257
2375
  # horizontal axis.
2258
2376
  #
2259
- # For more information, see DetectText in the Amazon Rekognition
2377
+ # For more information, see Detecting text in the Amazon Rekognition
2260
2378
  # Developer Guide.
2261
2379
  #
2262
2380
  # @option params [required, Types::Image] :image
@@ -2303,6 +2421,12 @@ module Aws::Rekognition
2303
2421
  # left: 1.0,
2304
2422
  # top: 1.0,
2305
2423
  # },
2424
+ # polygon: [
2425
+ # {
2426
+ # x: 1.0,
2427
+ # y: 1.0,
2428
+ # },
2429
+ # ],
2306
2430
  # },
2307
2431
  # ],
2308
2432
  # },
@@ -2381,7 +2505,7 @@ module Aws::Rekognition
2381
2505
  # an array of URLs. If there is no additional information about the
2382
2506
  # celebrity, this list is empty.
2383
2507
  #
2384
- # For more information, see Recognizing Celebrities in an Image in the
2508
+ # For more information, see Getting information about a celebrity in the
2385
2509
  # Amazon Rekognition Developer Guide.
2386
2510
  #
2387
2511
  # This operation requires permissions to perform the
@@ -2617,7 +2741,7 @@ module Aws::Rekognition
2617
2741
  # and populate the `NextToken` request parameter with the value of
2618
2742
  # `NextToken` returned from the previous call to `GetContentModeration`.
2619
2743
  #
2620
- # For more information, see Content moderation in the Amazon Rekognition
2744
+ # For more information, see moderating content in the Amazon Rekognition
2621
2745
  # Developer Guide.
2622
2746
  #
2623
2747
  #
@@ -3244,7 +3368,7 @@ module Aws::Rekognition
3244
3368
  # the `NextToken` request parameter with the token value returned from
3245
3369
  # the previous call to `GetSegmentDetection`.
3246
3370
  #
3247
- # For more information, see Detecting Video Segments in Stored Video in
3371
+ # For more information, see Detecting video segments in stored video in
3248
3372
  # the Amazon Rekognition Developer Guide.
3249
3373
  #
3250
3374
  # @option params [required, String] :job_id
@@ -3436,7 +3560,7 @@ module Aws::Rekognition
3436
3560
  # search operations using the SearchFaces and SearchFacesByImage
3437
3561
  # operations.
3438
3562
  #
3439
- # For more information, see Adding Faces to a Collection in the Amazon
3563
+ # For more information, see Adding faces to a collection in the Amazon
3440
3564
  # Rekognition Developer Guide.
3441
3565
  #
3442
3566
  # To get the number of faces in a collection, call DescribeCollection.
@@ -3517,9 +3641,9 @@ module Aws::Rekognition
3517
3641
  # `detectionAttributes` parameter), Amazon Rekognition returns detailed
3518
3642
  # facial attributes, such as facial landmarks (for example, location of
3519
3643
  # eye and mouth) and other facial attributes. If you provide the same
3520
- # image, specify the same collection, use the same external ID, and use
3521
- # the same model version in the `IndexFaces` operation, Amazon
3522
- # Rekognition doesn't save duplicate face metadata.
3644
+ # image, specify the same collection, and use the same external ID in
3645
+ # the `IndexFaces` operation, Amazon Rekognition doesn't save duplicate
3646
+ # face metadata.
3523
3647
  #
3524
3648
  #
3525
3649
  #
@@ -3860,7 +3984,7 @@ module Aws::Rekognition
3860
3984
  # truncated, the response also provides a `NextToken` that you can use
3861
3985
  # in the subsequent request to fetch the next set of collection IDs.
3862
3986
  #
3863
- # For an example, see Listing Collections in the Amazon Rekognition
3987
+ # For an example, see Listing collections in the Amazon Rekognition
3864
3988
  # Developer Guide.
3865
3989
  #
3866
3990
  # This operation requires permissions to perform the
@@ -4294,7 +4418,7 @@ module Aws::Rekognition
4294
4418
  # resp.next_token #=> String
4295
4419
  # resp.stream_processors #=> Array
4296
4420
  # resp.stream_processors[0].name #=> String
4297
- # resp.stream_processors[0].status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING"
4421
+ # resp.stream_processors[0].status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING", "UPDATING"
4298
4422
  #
4299
4423
  # @overload list_stream_processors(params = {})
4300
4424
  # @param [Hash] params ({})
@@ -4336,7 +4460,7 @@ module Aws::Rekognition
4336
4460
  end
4337
4461
 
4338
4462
  # Returns an array of celebrities recognized in the input image. For
4339
- # more information, see Recognizing Celebrities in the Amazon
4463
+ # more information, see Recognizing celebrities in the Amazon
4340
4464
  # Rekognition Developer Guide.
4341
4465
  #
4342
4466
  # `RecognizeCelebrities` returns the 64 largest faces in the image. It
@@ -4364,7 +4488,7 @@ module Aws::Rekognition
4364
4488
  # to call Amazon Rekognition operations, passing image bytes is not
4365
4489
  # supported. The image must be either a PNG or JPEG formatted file.
4366
4490
  #
4367
- # For an example, see Recognizing Celebrities in an Image in the Amazon
4491
+ # For an example, see Recognizing celebrities in an image in the Amazon
4368
4492
  # Rekognition Developer Guide.
4369
4493
  #
4370
4494
  # This operation requires permissions to perform the
@@ -4474,7 +4598,7 @@ module Aws::Rekognition
4474
4598
  # `confidence` value for each face match, indicating the confidence that
4475
4599
  # the specific face matches the input face.
4476
4600
  #
4477
- # For an example, see Searching for a Face Using Its Face ID in the
4601
+ # For an example, see Searching for a face using its face ID in the
4478
4602
  # Amazon Rekognition Developer Guide.
4479
4603
  #
4480
4604
  # This operation requires permissions to perform the
@@ -4792,7 +4916,7 @@ module Aws::Rekognition
4792
4916
  # identifier (`JobId`) from the initial call to
4793
4917
  # `StartCelebrityRecognition`.
4794
4918
  #
4795
- # For more information, see Recognizing Celebrities in the Amazon
4919
+ # For more information, see Recognizing celebrities in the Amazon
4796
4920
  # Rekognition Developer Guide.
4797
4921
  #
4798
4922
  # @option params [required, Types::Video] :video
@@ -4868,7 +4992,7 @@ module Aws::Rekognition
4868
4992
  # call GetContentModeration and pass the job identifier (`JobId`) from
4869
4993
  # the initial call to `StartContentModeration`.
4870
4994
  #
4871
- # For more information, see Content moderation in the Amazon Rekognition
4995
+ # For more information, see Moderating content in the Amazon Rekognition
4872
4996
  # Developer Guide.
4873
4997
  #
4874
4998
  #
@@ -4956,7 +5080,7 @@ module Aws::Rekognition
4956
5080
  # pass the job identifier (`JobId`) from the initial call to
4957
5081
  # `StartFaceDetection`.
4958
5082
  #
4959
- # For more information, see Detecting Faces in a Stored Video in the
5083
+ # For more information, see Detecting faces in a stored video in the
4960
5084
  # Amazon Rekognition Developer Guide.
4961
5085
  #
4962
5086
  # @option params [required, Types::Video] :video
@@ -5037,7 +5161,11 @@ module Aws::Rekognition
5037
5161
  # status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
5038
5162
  # call GetFaceSearch and pass the job identifier (`JobId`) from the
5039
5163
  # initial call to `StartFaceSearch`. For more information, see
5040
- # procedure-person-search-videos.
5164
+ # [Searching stored videos for faces][1].
5165
+ #
5166
+ #
5167
+ #
5168
+ # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html
5041
5169
  #
5042
5170
  # @option params [required, Types::Video] :video
5043
5171
  # The video you want to search. The video must be stored in an Amazon S3
@@ -5275,6 +5403,9 @@ module Aws::Rekognition
5275
5403
  #
5276
5404
  # </note>
5277
5405
  #
5406
+ # For more information, see *Running a trained Amazon Rekognition Custom
5407
+ # Labels model* in the Amazon Rekognition Custom Labels Guide.
5408
+ #
5278
5409
  # This operation requires permissions to perform the
5279
5410
  # `rekognition:StartProjectVersion` action.
5280
5411
  #
@@ -5284,10 +5415,20 @@ module Aws::Rekognition
5284
5415
  #
5285
5416
  # @option params [required, Integer] :min_inference_units
5286
5417
  # The minimum number of inference units to use. A single inference unit
5287
- # represents 1 hour of processing and can support up to 5 Transaction
5288
- # Pers Second (TPS). Use a higher number to increase the TPS throughput
5289
- # of your model. You are charged for the number of inference units that
5290
- # you use.
5418
+ # represents 1 hour of processing.
5419
+ #
5420
+ # For information about the number of transactions per second (TPS) that
5421
+ # an inference unit can support, see *Running a trained Amazon
5422
+ # Rekognition Custom Labels model* in the Amazon Rekognition Custom
5423
+ # Labels Guide.
5424
+ #
5425
+ # Use a higher number to increase the TPS throughput of your model. You
5426
+ # are charged for the number of inference units that you use.
5427
+ #
5428
+ # @option params [Integer] :max_inference_units
5429
+ # The maximum number of inference units to use for auto-scaling the
5430
+ # model. If you don't specify a value, Amazon Rekognition Custom Labels
5431
+ # doesn't auto-scale the model.
5291
5432
  #
5292
5433
  # @return [Types::StartProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5293
5434
  #
@@ -5298,6 +5439,7 @@ module Aws::Rekognition
5298
5439
  # resp = client.start_project_version({
5299
5440
  # project_version_arn: "ProjectVersionArn", # required
5300
5441
  # min_inference_units: 1, # required
5442
+ # max_inference_units: 1,
5301
5443
  # })
5302
5444
  #
5303
5445
  # @example Response structure
@@ -5333,7 +5475,7 @@ module Aws::Rekognition
5333
5475
  # `SUCCEEDED`. if so, call GetSegmentDetection and pass the job
5334
5476
  # identifier (`JobId`) from the initial call to `StartSegmentDetection`.
5335
5477
  #
5336
- # For more information, see Detecting Video Segments in Stored Video in
5478
+ # For more information, see Detecting video segments in stored video in
5337
5479
  # the Amazon Rekognition Developer Guide.
5338
5480
  #
5339
5481
  # @option params [required, Types::Video] :video
@@ -5419,17 +5561,55 @@ module Aws::Rekognition
5419
5561
  # stream processor to start, use the value of the `Name` field specified
5420
5562
  # in the call to `CreateStreamProcessor`.
5421
5563
  #
5564
+ # If you are using a label detection stream processor to detect labels,
5565
+ # you need to provide a `Start selector` and a `Stop selector` to
5566
+ # determine the length of the stream processing time.
5567
+ #
5422
5568
  # @option params [required, String] :name
5423
5569
  # The name of the stream processor to start processing.
5424
5570
  #
5425
- # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5571
+ # @option params [Types::StreamProcessingStartSelector] :start_selector
5572
+ # Specifies the starting point in the Kinesis stream to start
5573
+ # processing. You can use the producer timestamp or the fragment number.
5574
+ # For more information, see [Fragment][1].
5575
+ #
5576
+ # This is a required parameter for label detection stream processors and
5577
+ # should not be used to start a face search stream processor.
5578
+ #
5579
+ #
5580
+ #
5581
+ # [1]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html
5582
+ #
5583
+ # @option params [Types::StreamProcessingStopSelector] :stop_selector
5584
+ # Specifies when to stop processing the stream. You can specify a
5585
+ # maximum amount of time to process the video.
5586
+ #
5587
+ # This is a required parameter for label detection stream processors and
5588
+ # should not be used to start a face search stream processor.
5589
+ #
5590
+ # @return [Types::StartStreamProcessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5591
+ #
5592
+ # * {Types::StartStreamProcessorResponse#session_id #session_id} => String
5426
5593
  #
5427
5594
  # @example Request syntax with placeholder values
5428
5595
  #
5429
5596
  # resp = client.start_stream_processor({
5430
5597
  # name: "StreamProcessorName", # required
5598
+ # start_selector: {
5599
+ # kvs_stream_start_selector: {
5600
+ # producer_timestamp: 1,
5601
+ # fragment_number: "KinesisVideoStreamFragmentNumber",
5602
+ # },
5603
+ # },
5604
+ # stop_selector: {
5605
+ # max_duration_in_seconds: 1,
5606
+ # },
5431
5607
  # })
5432
5608
  #
5609
+ # @example Response structure
5610
+ #
5611
+ # resp.session_id #=> String
5612
+ #
5433
5613
  # @overload start_stream_processor(params = {})
5434
5614
  # @param [Hash] params ({})
5435
5615
  def start_stream_processor(params = {}, options = {})
@@ -5467,15 +5647,17 @@ module Aws::Rekognition
5467
5647
  # @option params [Types::NotificationChannel] :notification_channel
5468
5648
  # The Amazon Simple Notification Service topic to which Amazon
5469
5649
  # Rekognition publishes the completion status of a video analysis
5470
- # operation. For more information, see api-video. Note that the Amazon
5471
- # SNS topic must have a topic name that begins with *AmazonRekognition*
5472
- # if you are using the AmazonRekognitionServiceRole permissions policy
5473
- # to access the topic. For more information, see [Giving access to
5474
- # multiple Amazon SNS topics][1].
5650
+ # operation. For more information, see [Calling Amazon Rekognition Video
5651
+ # operations][1]. Note that the Amazon SNS topic must have a topic name
5652
+ # that begins with *AmazonRekognition* if you are using the
5653
+ # AmazonRekognitionServiceRole permissions policy to access the topic.
5654
+ # For more information, see [Giving access to multiple Amazon SNS
5655
+ # topics][2].
5475
5656
  #
5476
5657
  #
5477
5658
  #
5478
- # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics
5659
+ # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html
5660
+ # [2]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics
5479
5661
  #
5480
5662
  # @option params [String] :job_tag
5481
5663
  # An identifier returned in the completion status published by your
@@ -5521,6 +5703,12 @@ module Aws::Rekognition
5521
5703
  # left: 1.0,
5522
5704
  # top: 1.0,
5523
5705
  # },
5706
+ # polygon: [
5707
+ # {
5708
+ # x: 1.0,
5709
+ # y: 1.0,
5710
+ # },
5711
+ # ],
5524
5712
  # },
5525
5713
  # ],
5526
5714
  # },
@@ -5709,6 +5897,72 @@ module Aws::Rekognition
5709
5897
  req.send_request(options)
5710
5898
  end
5711
5899
 
5900
+ # Allows you to update a stream processor. You can change some settings
5901
+ # and regions of interest and delete certain parameters.
5902
+ #
5903
+ # @option params [required, String] :name
5904
+ # Name of the stream processor that you want to update.
5905
+ #
5906
+ # @option params [Types::StreamProcessorSettingsForUpdate] :settings_for_update
5907
+ # The stream processor settings that you want to update. Label detection
5908
+ # settings can be updated to detect different labels with a different
5909
+ # minimum confidence.
5910
+ #
5911
+ # @option params [Array<Types::RegionOfInterest>] :regions_of_interest_for_update
5912
+ # Specifies locations in the frames where Amazon Rekognition checks for
5913
+ # objects or people. This is an optional parameter for label detection
5914
+ # stream processors.
5915
+ #
5916
+ # @option params [Types::StreamProcessorDataSharingPreference] :data_sharing_preference_for_update
5917
+ # Shows whether you are sharing data with Rekognition to improve model
5918
+ # performance. You can choose this option at the account level or on a
5919
+ # per-stream basis. Note that if you opt out at the account level this
5920
+ # setting is ignored on individual streams.
5921
+ #
5922
+ # @option params [Array<String>] :parameters_to_delete
5923
+ # A list of parameters you want to delete from the stream processor.
5924
+ #
5925
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5926
+ #
5927
+ # @example Request syntax with placeholder values
5928
+ #
5929
+ # resp = client.update_stream_processor({
5930
+ # name: "StreamProcessorName", # required
5931
+ # settings_for_update: {
5932
+ # connected_home_for_update: {
5933
+ # labels: ["ConnectedHomeLabel"],
5934
+ # min_confidence: 1.0,
5935
+ # },
5936
+ # },
5937
+ # regions_of_interest_for_update: [
5938
+ # {
5939
+ # bounding_box: {
5940
+ # width: 1.0,
5941
+ # height: 1.0,
5942
+ # left: 1.0,
5943
+ # top: 1.0,
5944
+ # },
5945
+ # polygon: [
5946
+ # {
5947
+ # x: 1.0,
5948
+ # y: 1.0,
5949
+ # },
5950
+ # ],
5951
+ # },
5952
+ # ],
5953
+ # data_sharing_preference_for_update: {
5954
+ # opt_in: false, # required
5955
+ # },
5956
+ # parameters_to_delete: ["ConnectedHomeMinConfidence"], # accepts ConnectedHomeMinConfidence, RegionsOfInterest
5957
+ # })
5958
+ #
5959
+ # @overload update_stream_processor(params = {})
5960
+ # @param [Hash] params ({})
5961
+ def update_stream_processor(params = {}, options = {})
5962
+ req = build_request(:update_stream_processor, params)
5963
+ req.send_request(options)
5964
+ end
5965
+
5712
5966
  # @!endgroup
5713
5967
 
5714
5968
  # @param params ({})
@@ -5722,7 +5976,7 @@ module Aws::Rekognition
5722
5976
  params: params,
5723
5977
  config: config)
5724
5978
  context[:gem_name] = 'aws-sdk-rekognition'
5725
- context[:gem_version] = '1.66.0'
5979
+ context[:gem_version] = '1.69.0'
5726
5980
  Seahorse::Client::Request.new(handlers, context)
5727
5981
  end
5728
5982