aws-sdk-rekognition 1.35.0 → 1.40.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 514bc86c1903620e2d258dffacb5941df5161419
4
- data.tar.gz: c31c7c73c983110607191ded3b24d42aa0f836ab
2
+ SHA256:
3
+ metadata.gz: 067f989aae540c670ca14e89b775e73fd60fb95440188dd5762dbd3302008dd4
4
+ data.tar.gz: 66aad6d16f260d976bfa277f75d8a1985dd315a468c90adeea324913c59590ba
5
5
  SHA512:
6
- metadata.gz: 61594bbf3f3f369ae31d5b02edd99135ebe2ba510646c5bbfd72e49a9e5022ddce2cac777e285368e02aef64829cba3407bf49ed88493ca863ec13767f479f78
7
- data.tar.gz: 0a5762441557512743ab9eb93b3953743db65aedafd908d5936ccf6376f568d59849ceda6cb567ac5b91a10feaeb6e52cb1b4957ac0fbad7ac21bf71d8162317
6
+ metadata.gz: 8f0e33c78279aba850dd790df5efdf3f0998e760d1d9a0cbaff53a49e6ee3c49e5077f236b6b99138e3e334484ee70dea9e469653e6b2c4345fdd838169d7ed7
7
+ data.tar.gz: 842bb403a8517f6a2cda864bfca3e297c76818c7af66c1cb87b536e78d4a3dc699653a395e23e546cf77573ce08319176b90f48c1081f26cfbc17a4e3bdaea13
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -46,6 +48,6 @@ require_relative 'aws-sdk-rekognition/customizations'
46
48
  # @service
47
49
  module Aws::Rekognition
48
50
 
49
- GEM_VERSION = '1.35.0'
51
+ GEM_VERSION = '1.40.0'
50
52
 
51
53
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
32
 
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:rekognition)
32
35
  module Aws::Rekognition
33
36
  # An API client for Rekognition. To construct a client, you need to configure a `:region` and `:credentials`.
34
37
  #
35
- # client = Aws::Rekognition::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
38
+ # client = Aws::Rekognition::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
40
43
  #
41
44
  # For details on configuring region and credentials see
42
45
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -69,6 +72,7 @@ module Aws::Rekognition
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
74
78
 
@@ -105,7 +109,7 @@ module Aws::Rekognition
105
109
  # @option options [required, String] :region
106
110
  # The AWS region to connect to. The configured `:region` is
107
111
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
109
113
  #
110
114
  # * `Aws.config[:region]`
111
115
  # * `ENV['AWS_REGION']`
@@ -161,7 +165,7 @@ module Aws::Rekognition
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::Rekognition
176
180
  # requests fetching endpoints information. Defaults to 60 sec.
177
181
  #
178
182
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
184
  #
181
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
186
  # The log formatter.
@@ -229,15 +233,19 @@ module Aws::Rekognition
229
233
  #
230
234
  # @option options [String] :retry_mode ("legacy")
231
235
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
241
249
  #
242
250
  # @option options [String] :secret_access_key
243
251
  #
@@ -275,8 +283,7 @@ module Aws::Rekognition
275
283
  #
276
284
  # @option options [Integer] :http_read_timeout (60) The default
277
285
  # number of seconds to wait for response data. This value can
278
- # safely be set
279
- # per-request on the session yielded by {#session_for}.
286
+ # safely be set per-request on the session.
280
287
  #
281
288
  # @option options [Float] :http_idle_timeout (5) The number of
282
289
  # seconds a connection is allowed to sit idle before it is
@@ -288,7 +295,7 @@ module Aws::Rekognition
288
295
  # request body. This option has no effect unless the request has
289
296
  # "Expect" header set to "100-continue". Defaults to `nil` which
290
297
  # disables this behaviour. This value can safely be set per
291
- # request on the session yielded by {#session_for}.
298
+ # request on the session.
292
299
  #
293
300
  # @option options [Boolean] :http_wire_trace (false) When `true`,
294
301
  # HTTP debug output will be sent to the `:logger`.
@@ -905,6 +912,72 @@ module Aws::Rekognition
905
912
  req.send_request(options)
906
913
  end
907
914
 
915
+ # Deletes an Amazon Rekognition Custom Labels project. To delete a
916
+ # project you must first delete all models associated with the project.
917
+ # To delete a model, see DeleteProjectVersion.
918
+ #
919
+ # This operation requires permissions to perform the
920
+ # `rekognition:DeleteProject` action.
921
+ #
922
+ # @option params [required, String] :project_arn
923
+ # The Amazon Resource Name (ARN) of the project that you want to delete.
924
+ #
925
+ # @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
926
+ #
927
+ # * {Types::DeleteProjectResponse#status #status} => String
928
+ #
929
+ # @example Request syntax with placeholder values
930
+ #
931
+ # resp = client.delete_project({
932
+ # project_arn: "ProjectArn", # required
933
+ # })
934
+ #
935
+ # @example Response structure
936
+ #
937
+ # resp.status #=> String, one of "CREATING", "CREATED", "DELETING"
938
+ #
939
+ # @overload delete_project(params = {})
940
+ # @param [Hash] params ({})
941
+ def delete_project(params = {}, options = {})
942
+ req = build_request(:delete_project, params)
943
+ req.send_request(options)
944
+ end
945
+
946
+ # Deletes an Amazon Rekognition Custom Labels model.
947
+ #
948
+ # You can't delete a model if it is running or if it is training. To
949
+ # check the status of a model, use the `Status` field returned from
950
+ # DescribeProjectVersions. To stop a running model call
951
+ # StopProjectVersion. If the model is training, wait until it finishes.
952
+ #
953
+ # This operation requires permissions to perform the
954
+ # `rekognition:DeleteProjectVersion` action.
955
+ #
956
+ # @option params [required, String] :project_version_arn
957
+ # The Amazon Resource Name (ARN) of the model version that you want to
958
+ # delete.
959
+ #
960
+ # @return [Types::DeleteProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
961
+ #
962
+ # * {Types::DeleteProjectVersionResponse#status #status} => String
963
+ #
964
+ # @example Request syntax with placeholder values
965
+ #
966
+ # resp = client.delete_project_version({
967
+ # project_version_arn: "ProjectVersionArn", # required
968
+ # })
969
+ #
970
+ # @example Response structure
971
+ #
972
+ # resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
973
+ #
974
+ # @overload delete_project_version(params = {})
975
+ # @param [Hash] params ({})
976
+ def delete_project_version(params = {}, options = {})
977
+ req = build_request(:delete_project_version, params)
978
+ req.send_request(options)
979
+ end
980
+
908
981
  # Deletes the stream processor identified by `Name`. You assign the
909
982
  # value for `Name` when you create the stream processor with
910
983
  # CreateStreamProcessor. You might not be able to use the same name for
@@ -982,7 +1055,11 @@ module Aws::Rekognition
982
1055
  # @option params [Array<String>] :version_names
983
1056
  # A list of model version names that you want to describe. You can add
984
1057
  # up to 10 model version names to the list. If you don't specify a
985
- # value, all model descriptions are returned.
1058
+ # value, all model descriptions are returned. A version name is part of
1059
+ # a model (ProjectVersion) ARN. For example,
1060
+ # `my-model.2020-01-21T09.10.15` is the version name in the following
1061
+ # ARN.
1062
+ # `arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123`.
986
1063
  #
987
1064
  # @option params [String] :next_token
988
1065
  # If the previous response was incomplete (because there is more results
@@ -1001,6 +1078,8 @@ module Aws::Rekognition
1001
1078
  # * {Types::DescribeProjectVersionsResponse#project_version_descriptions #project_version_descriptions} => Array&lt;Types::ProjectVersionDescription&gt;
1002
1079
  # * {Types::DescribeProjectVersionsResponse#next_token #next_token} => String
1003
1080
  #
1081
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1082
+ #
1004
1083
  # @example Request syntax with placeholder values
1005
1084
  #
1006
1085
  # resp = client.describe_project_versions({
@@ -1046,6 +1125,12 @@ module Aws::Rekognition
1046
1125
  # resp.project_version_descriptions[0].evaluation_result.summary.s3_object.version #=> String
1047
1126
  # resp.next_token #=> String
1048
1127
  #
1128
+ #
1129
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1130
+ #
1131
+ # * project_version_running
1132
+ # * project_version_training_completed
1133
+ #
1049
1134
  # @overload describe_project_versions(params = {})
1050
1135
  # @param [Hash] params ({})
1051
1136
  def describe_project_versions(params = {}, options = {})
@@ -1076,6 +1161,8 @@ module Aws::Rekognition
1076
1161
  # * {Types::DescribeProjectsResponse#project_descriptions #project_descriptions} => Array&lt;Types::ProjectDescription&gt;
1077
1162
  # * {Types::DescribeProjectsResponse#next_token #next_token} => String
1078
1163
  #
1164
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1165
+ #
1079
1166
  # @example Request syntax with placeholder values
1080
1167
  #
1081
1168
  # resp = client.describe_projects({
@@ -1937,6 +2024,8 @@ module Aws::Rekognition
1937
2024
  # * {Types::GetCelebrityRecognitionResponse#next_token #next_token} => String
1938
2025
  # * {Types::GetCelebrityRecognitionResponse#celebrities #celebrities} => Array&lt;Types::CelebrityRecognition&gt;
1939
2026
  #
2027
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2028
+ #
1940
2029
  # @example Request syntax with placeholder values
1941
2030
  #
1942
2031
  # resp = client.get_celebrity_recognition({
@@ -2080,6 +2169,8 @@ module Aws::Rekognition
2080
2169
  # * {Types::GetContentModerationResponse#next_token #next_token} => String
2081
2170
  # * {Types::GetContentModerationResponse#moderation_model_version #moderation_model_version} => String
2082
2171
  #
2172
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2173
+ #
2083
2174
  # @example Request syntax with placeholder values
2084
2175
  #
2085
2176
  # resp = client.get_content_moderation({
@@ -2162,6 +2253,8 @@ module Aws::Rekognition
2162
2253
  # * {Types::GetFaceDetectionResponse#next_token #next_token} => String
2163
2254
  # * {Types::GetFaceDetectionResponse#faces #faces} => Array&lt;Types::FaceDetection&gt;
2164
2255
  #
2256
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2257
+ #
2165
2258
  # @example Request syntax with placeholder values
2166
2259
  #
2167
2260
  # resp = client.get_face_detection({
@@ -2291,6 +2384,8 @@ module Aws::Rekognition
2291
2384
  # * {Types::GetFaceSearchResponse#video_metadata #video_metadata} => Types::VideoMetadata
2292
2385
  # * {Types::GetFaceSearchResponse#persons #persons} => Array&lt;Types::PersonMatch&gt;
2293
2386
  #
2387
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2388
+ #
2294
2389
  # @example Request syntax with placeholder values
2295
2390
  #
2296
2391
  # resp = client.get_face_search({
@@ -2437,6 +2532,8 @@ module Aws::Rekognition
2437
2532
  # * {Types::GetLabelDetectionResponse#labels #labels} => Array&lt;Types::LabelDetection&gt;
2438
2533
  # * {Types::GetLabelDetectionResponse#label_model_version #label_model_version} => String
2439
2534
  #
2535
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2536
+ #
2440
2537
  # @example Request syntax with placeholder values
2441
2538
  #
2442
2539
  # resp = client.get_label_detection({
@@ -2548,6 +2645,8 @@ module Aws::Rekognition
2548
2645
  # * {Types::GetPersonTrackingResponse#next_token #next_token} => String
2549
2646
  # * {Types::GetPersonTrackingResponse#persons #persons} => Array&lt;Types::PersonDetection&gt;
2550
2647
  #
2648
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2649
+ #
2551
2650
  # @example Request syntax with placeholder values
2552
2651
  #
2553
2652
  # resp = client.get_person_tracking({
@@ -2618,6 +2717,116 @@ module Aws::Rekognition
2618
2717
  req.send_request(options)
2619
2718
  end
2620
2719
 
2720
+ # Gets the segment detection results of a Amazon Rekognition Video
2721
+ # analysis started by StartSegmentDetection.
2722
+ #
2723
+ # Segment detection with Amazon Rekognition Video is an asynchronous
2724
+ # operation. You start segment detection by calling
2725
+ # StartSegmentDetection which returns a job identifier (`JobId`). When
2726
+ # the segment detection operation finishes, Amazon Rekognition publishes
2727
+ # a completion status to the Amazon Simple Notification Service topic
2728
+ # registered in the initial call to `StartSegmentDetection`. To get the
2729
+ # results of the segment detection operation, first check that the
2730
+ # status value published to the Amazon SNS topic is `SUCCEEDED`. if so,
2731
+ # call `GetSegmentDetection` and pass the job identifier (`JobId`) from
2732
+ # the initial call of `StartSegmentDetection`.
2733
+ #
2734
+ # `GetSegmentDetection` returns detected segments in an array
2735
+ # (`Segments`) of SegmentDetection objects. `Segments` is sorted by the
2736
+ # segment types specified in the `SegmentTypes` input parameter of
2737
+ # `StartSegmentDetection`. Each element of the array includes the
2738
+ # detected segment, the precentage confidence in the acuracy of the
2739
+ # detected segment, the type of the segment, and the frame in which the
2740
+ # segment was detected.
2741
+ #
2742
+ # Use `SelectedSegmentTypes` to find out the type of segment detection
2743
+ # requested in the call to `StartSegmentDetection`.
2744
+ #
2745
+ # Use the `MaxResults` parameter to limit the number of segment
2746
+ # detections returned. If there are more results than specified in
2747
+ # `MaxResults`, the value of `NextToken` in the operation response
2748
+ # contains a pagination token for getting the next set of results. To
2749
+ # get the next page of results, call `GetSegmentDetection` and populate
2750
+ # the `NextToken` request parameter with the token value returned from
2751
+ # the previous call to `GetSegmentDetection`.
2752
+ #
2753
+ # For more information, see Detecting Video Segments in Stored Video in
2754
+ # the Amazon Rekognition Developer Guide.
2755
+ #
2756
+ # @option params [required, String] :job_id
2757
+ # Job identifier for the text detection operation for which you want
2758
+ # results returned. You get the job identifer from an initial call to
2759
+ # `StartSegmentDetection`.
2760
+ #
2761
+ # @option params [Integer] :max_results
2762
+ # Maximum number of results to return per paginated call. The largest
2763
+ # value you can specify is 1000.
2764
+ #
2765
+ # @option params [String] :next_token
2766
+ # If the response is truncated, Amazon Rekognition Video returns this
2767
+ # token that you can use in the subsequent request to retrieve the next
2768
+ # set of text.
2769
+ #
2770
+ # @return [Types::GetSegmentDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2771
+ #
2772
+ # * {Types::GetSegmentDetectionResponse#job_status #job_status} => String
2773
+ # * {Types::GetSegmentDetectionResponse#status_message #status_message} => String
2774
+ # * {Types::GetSegmentDetectionResponse#video_metadata #video_metadata} => Array&lt;Types::VideoMetadata&gt;
2775
+ # * {Types::GetSegmentDetectionResponse#audio_metadata #audio_metadata} => Array&lt;Types::AudioMetadata&gt;
2776
+ # * {Types::GetSegmentDetectionResponse#next_token #next_token} => String
2777
+ # * {Types::GetSegmentDetectionResponse#segments #segments} => Array&lt;Types::SegmentDetection&gt;
2778
+ # * {Types::GetSegmentDetectionResponse#selected_segment_types #selected_segment_types} => Array&lt;Types::SegmentTypeInfo&gt;
2779
+ #
2780
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2781
+ #
2782
+ # @example Request syntax with placeholder values
2783
+ #
2784
+ # resp = client.get_segment_detection({
2785
+ # job_id: "JobId", # required
2786
+ # max_results: 1,
2787
+ # next_token: "PaginationToken",
2788
+ # })
2789
+ #
2790
+ # @example Response structure
2791
+ #
2792
+ # resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
2793
+ # resp.status_message #=> String
2794
+ # resp.video_metadata #=> Array
2795
+ # resp.video_metadata[0].codec #=> String
2796
+ # resp.video_metadata[0].duration_millis #=> Integer
2797
+ # resp.video_metadata[0].format #=> String
2798
+ # resp.video_metadata[0].frame_rate #=> Float
2799
+ # resp.video_metadata[0].frame_height #=> Integer
2800
+ # resp.video_metadata[0].frame_width #=> Integer
2801
+ # resp.audio_metadata #=> Array
2802
+ # resp.audio_metadata[0].codec #=> String
2803
+ # resp.audio_metadata[0].duration_millis #=> Integer
2804
+ # resp.audio_metadata[0].sample_rate #=> Integer
2805
+ # resp.audio_metadata[0].number_of_channels #=> Integer
2806
+ # resp.next_token #=> String
2807
+ # resp.segments #=> Array
2808
+ # resp.segments[0].type #=> String, one of "TECHNICAL_CUE", "SHOT"
2809
+ # resp.segments[0].start_timestamp_millis #=> Integer
2810
+ # resp.segments[0].end_timestamp_millis #=> Integer
2811
+ # resp.segments[0].duration_millis #=> Integer
2812
+ # resp.segments[0].start_timecode_smpte #=> String
2813
+ # resp.segments[0].end_timecode_smpte #=> String
2814
+ # resp.segments[0].duration_smpte #=> String
2815
+ # resp.segments[0].technical_cue_segment.type #=> String, one of "ColorBars", "EndCredits", "BlackFrames"
2816
+ # resp.segments[0].technical_cue_segment.confidence #=> Float
2817
+ # resp.segments[0].shot_segment.index #=> Integer
2818
+ # resp.segments[0].shot_segment.confidence #=> Float
2819
+ # resp.selected_segment_types #=> Array
2820
+ # resp.selected_segment_types[0].type #=> String, one of "TECHNICAL_CUE", "SHOT"
2821
+ # resp.selected_segment_types[0].model_version #=> String
2822
+ #
2823
+ # @overload get_segment_detection(params = {})
2824
+ # @param [Hash] params ({})
2825
+ def get_segment_detection(params = {}, options = {})
2826
+ req = build_request(:get_segment_detection, params)
2827
+ req.send_request(options)
2828
+ end
2829
+
2621
2830
  # Gets the text detection results of a Amazon Rekognition Video analysis
2622
2831
  # started by StartTextDetection.
2623
2832
  #
@@ -2650,7 +2859,7 @@ module Aws::Rekognition
2650
2859
  # to `GetTextDetection`.
2651
2860
  #
2652
2861
  # @option params [required, String] :job_id
2653
- # Job identifier for the label detection operation for which you want
2862
+ # Job identifier for the text detection operation for which you want
2654
2863
  # results returned. You get the job identifer from an initial call to
2655
2864
  # `StartTextDetection`.
2656
2865
  #
@@ -2673,6 +2882,8 @@ module Aws::Rekognition
2673
2882
  # * {Types::GetTextDetectionResponse#next_token #next_token} => String
2674
2883
  # * {Types::GetTextDetectionResponse#text_model_version #text_model_version} => String
2675
2884
  #
2885
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2886
+ #
2676
2887
  # @example Request syntax with placeholder values
2677
2888
  #
2678
2889
  # resp = client.get_text_detection({
@@ -2747,7 +2958,7 @@ module Aws::Rekognition
2747
2958
  # For more information, see Model Versioning in the Amazon Rekognition
2748
2959
  # Developer Guide.
2749
2960
  #
2750
- # If you provide the optional `ExternalImageID` for the input image you
2961
+ # If you provide the optional `ExternalImageId` for the input image you
2751
2962
  # provided, Amazon Rekognition associates this ID with all faces that it
2752
2963
  # detects. When you call the ListFaces operation, the response returns
2753
2964
  # the external ID. You can use this external image ID to create a
@@ -3167,6 +3378,8 @@ module Aws::Rekognition
3167
3378
  # * {Types::ListCollectionsResponse#next_token #next_token} => String
3168
3379
  # * {Types::ListCollectionsResponse#face_model_versions #face_model_versions} => Array&lt;String&gt;
3169
3380
  #
3381
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3382
+ #
3170
3383
  #
3171
3384
  # @example Example: To list the collections
3172
3385
  #
@@ -3231,6 +3444,8 @@ module Aws::Rekognition
3231
3444
  # * {Types::ListFacesResponse#next_token #next_token} => String
3232
3445
  # * {Types::ListFacesResponse#face_model_version #face_model_version} => String
3233
3446
  #
3447
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3448
+ #
3234
3449
  #
3235
3450
  # @example Example: To list the faces in a collection
3236
3451
  #
@@ -3415,6 +3630,8 @@ module Aws::Rekognition
3415
3630
  # * {Types::ListStreamProcessorsResponse#next_token #next_token} => String
3416
3631
  # * {Types::ListStreamProcessorsResponse#stream_processors #stream_processors} => Array&lt;Types::StreamProcessor&gt;
3417
3632
  #
3633
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3634
+ #
3418
3635
  # @example Request syntax with placeholder values
3419
3636
  #
3420
3637
  # resp = client.list_stream_processors({
@@ -4376,6 +4593,103 @@ module Aws::Rekognition
4376
4593
  req.send_request(options)
4377
4594
  end
4378
4595
 
4596
+ # Starts asynchronous detection of segment detection in a stored video.
4597
+ #
4598
+ # Amazon Rekognition Video can detect segments in a video stored in an
4599
+ # Amazon S3 bucket. Use Video to specify the bucket name and the
4600
+ # filename of the video. `StartSegmentDetection` returns a job
4601
+ # identifier (`JobId`) which you use to get the results of the
4602
+ # operation. When segment detection is finished, Amazon Rekognition
4603
+ # Video publishes a completion status to the Amazon Simple Notification
4604
+ # Service topic that you specify in `NotificationChannel`.
4605
+ #
4606
+ # You can use the `Filters` (StartSegmentDetectionFilters) input
4607
+ # parameter to specify the minimum detection confidence returned in the
4608
+ # response. Within `Filters`, use `ShotFilter`
4609
+ # (StartShotDetectionFilter) to filter detected shots. Use
4610
+ # `TechnicalCueFilter` (StartTechnicalCueDetectionFilter) to filter
4611
+ # technical cues.
4612
+ #
4613
+ # To get the results of the segment detection operation, first check
4614
+ # that the status value published to the Amazon SNS topic is
4615
+ # `SUCCEEDED`. if so, call GetSegmentDetection and pass the job
4616
+ # identifier (`JobId`) from the initial call to `StartSegmentDetection`.
4617
+ #
4618
+ # For more information, see Detecting Video Segments in Stored Video in
4619
+ # the Amazon Rekognition Developer Guide.
4620
+ #
4621
+ # @option params [required, Types::Video] :video
4622
+ # Video file stored in an Amazon S3 bucket. Amazon Rekognition video
4623
+ # start operations such as StartLabelDetection use `Video` to specify a
4624
+ # video for analysis. The supported file formats are .mp4, .mov and
4625
+ # .avi.
4626
+ #
4627
+ # @option params [String] :client_request_token
4628
+ # Idempotent token used to identify the start request. If you use the
4629
+ # same token with multiple `StartSegmentDetection` requests, the same
4630
+ # `JobId` is returned. Use `ClientRequestToken` to prevent the same job
4631
+ # from being accidently started more than once.
4632
+ #
4633
+ # @option params [Types::NotificationChannel] :notification_channel
4634
+ # The ARN of the Amazon SNS topic to which you want Amazon Rekognition
4635
+ # Video to publish the completion status of the segment detection
4636
+ # operation.
4637
+ #
4638
+ # @option params [String] :job_tag
4639
+ # An identifier you specify that's returned in the completion
4640
+ # notification that's published to your Amazon Simple Notification
4641
+ # Service topic. For example, you can use `JobTag` to group related jobs
4642
+ # and identify them in the completion notification.
4643
+ #
4644
+ # @option params [Types::StartSegmentDetectionFilters] :filters
4645
+ # Filters for technical cue or shot detection.
4646
+ #
4647
+ # @option params [required, Array<String>] :segment_types
4648
+ # An array of segment types to detect in the video. Valid values are
4649
+ # TECHNICAL\_CUE and SHOT.
4650
+ #
4651
+ # @return [Types::StartSegmentDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4652
+ #
4653
+ # * {Types::StartSegmentDetectionResponse#job_id #job_id} => String
4654
+ #
4655
+ # @example Request syntax with placeholder values
4656
+ #
4657
+ # resp = client.start_segment_detection({
4658
+ # video: { # required
4659
+ # s3_object: {
4660
+ # bucket: "S3Bucket",
4661
+ # name: "S3ObjectName",
4662
+ # version: "S3ObjectVersion",
4663
+ # },
4664
+ # },
4665
+ # client_request_token: "ClientRequestToken",
4666
+ # notification_channel: {
4667
+ # sns_topic_arn: "SNSTopicArn", # required
4668
+ # role_arn: "RoleArn", # required
4669
+ # },
4670
+ # job_tag: "JobTag",
4671
+ # filters: {
4672
+ # technical_cue_filter: {
4673
+ # min_segment_confidence: 1.0,
4674
+ # },
4675
+ # shot_filter: {
4676
+ # min_segment_confidence: 1.0,
4677
+ # },
4678
+ # },
4679
+ # segment_types: ["TECHNICAL_CUE"], # required, accepts TECHNICAL_CUE, SHOT
4680
+ # })
4681
+ #
4682
+ # @example Response structure
4683
+ #
4684
+ # resp.job_id #=> String
4685
+ #
4686
+ # @overload start_segment_detection(params = {})
4687
+ # @param [Hash] params ({})
4688
+ def start_segment_detection(params = {}, options = {})
4689
+ req = build_request(:start_segment_detection, params)
4690
+ req.send_request(options)
4691
+ end
4692
+
4379
4693
  # Starts processing a stream processor. You create a stream processor by
4380
4694
  # calling CreateStreamProcessor. To tell `StartStreamProcessor` which
4381
4695
  # stream processor to start, use the value of the `Name` field specified
@@ -4556,7 +4870,7 @@ module Aws::Rekognition
4556
4870
  params: params,
4557
4871
  config: config)
4558
4872
  context[:gem_name] = 'aws-sdk-rekognition'
4559
- context[:gem_version] = '1.35.0'
4873
+ context[:gem_version] = '1.40.0'
4560
4874
  Seahorse::Client::Request.new(handlers, context)
4561
4875
  end
4562
4876
 
@@ -4622,10 +4936,10 @@ module Aws::Rekognition
4622
4936
  # The following table lists the valid waiter names, the operations they call,
4623
4937
  # and the default `:delay` and `:max_attempts` values.
4624
4938
  #
4625
- # | waiter_name | params | :delay | :max_attempts |
4626
- # | ---------------------------------- | ---------------------------- | -------- | ------------- |
4627
- # | project_version_running | {#describe_project_versions} | 30 | 40 |
4628
- # | project_version_training_completed | {#describe_project_versions} | 120 | 360 |
4939
+ # | waiter_name | params | :delay | :max_attempts |
4940
+ # | ---------------------------------- | ---------------------------------- | -------- | ------------- |
4941
+ # | project_version_running | {Client#describe_project_versions} | 30 | 40 |
4942
+ # | project_version_training_completed | {Client#describe_project_versions} | 120 | 360 |
4629
4943
  #
4630
4944
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
4631
4945
  # because the waiter has entered a state that it will not transition