aws-sdk-rekognition 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0073779d5db2875ab000e60fa739f8731b4fccb8'
-  data.tar.gz: 7427f1652ab2e61ae91127e38a47b03bbb18eec2
+  metadata.gz: be8aeee40c517d2db7bdb3d1f4cc5e8ac57981c5
+  data.tar.gz: cde89b0c775fd9a9fd709753ec4ebff46e78078e
 SHA512:
-  metadata.gz: 386fcd38b965c535dd8d2286633f826b77b8e30f9fb4e1b72e784b892aa62c817283aa4066778d133e0542baa295652833328a32b19283ac3cc2147ec85a132d
-  data.tar.gz: 2f3b0a9813affe582a4129d7de1ccaaa91b2f6c95fa49445664a3d3fa289c7c65c1c79ce15e9012106cec4f5e3b53f883a3f6cbf408f0656eef39973abbf130d
+  metadata.gz: 592a0b5cc96f6bf397006b23138f5d6fab76ab2b7ae4d13de4b859f00b6c1d2ca5857d030c4960e8105995b202a2bd28b62ffcca9c3b3ad7d29e79168159da63
+  data.tar.gz: 00b37a0363372228ad146c5381e1f047f8b5719b0b3d123f8a776cda6b69d0bbeb54600024bf301377098036aa6bb7780b4bf82735872818e09b471bacce0292

data/lib/aws-sdk-rekognition.rb

@@ -43,6 +43,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.33.0'
+  GEM_VERSION = '1.34.0'
 
 end

data/lib/aws-sdk-rekognition/client.rb

@@ -1230,9 +1230,9 @@ module Aws::Rekognition
     # faces or might detect faces with lower confidence.
     #
     # You pass the input image either as base64-encoded image bytes or as a
-    # reference to an image in an Amazon S3 bucket. If you use the to call
-    # Amazon Rekognition operations, passing image bytes is not supported.
-    # The image must be either a PNG or JPEG formatted file.
+    # reference to an image in an Amazon S3 bucket. If you use the AWS CLI
+    # to call Amazon Rekognition operations, passing image bytes is not
+    # supported. The image must be either a PNG or JPEG formatted file.
     #
     # <note markdown="1"> This is a stateless API operation. That is, the operation does not
     # persist any data.
@@ -1704,9 +1704,14 @@ module Aws::Rekognition
     #   more information, see Images in the Amazon Rekognition developer
     #   guide.
     #
+    # @option params [Types::DetectTextFilters] :filters
+    #   Optional parameters that let you set the criteria that the text must
+    #   meet to be included in your response.
+    #
     # @return [Types::DetectTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DetectTextResponse#text_detections #text_detections} => Array&lt;Types::TextDetection&gt;
+    #   * {Types::DetectTextResponse#text_model_version #text_model_version} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1719,6 +1724,23 @@ module Aws::Rekognition
     #         version: "S3ObjectVersion",
     #       },
     #     },
+    #     filters: {
+    #       word_filter: {
+    #         min_confidence: 1.0,
+    #         min_bounding_box_height: 1.0,
+    #         min_bounding_box_width: 1.0,
+    #       },
+    #       regions_of_interest: [
+    #         {
+    #           bounding_box: {
+    #             width: 1.0,
+    #             height: 1.0,
+    #             left: 1.0,
+    #             top: 1.0,
+    #           },
+    #         },
+    #       ],
+    #     },
     #   })
     #
     # @example Response structure
@@ -1736,6 +1758,7 @@ module Aws::Rekognition
     #   resp.text_detections[0].geometry.polygon #=> Array
     #   resp.text_detections[0].geometry.polygon[0].x #=> Float
     #   resp.text_detections[0].geometry.polygon[0].y #=> Float
+    #   resp.text_model_version #=> String
     #
     # @overload detect_text(params = {})
     # @param [Hash] params ({})
@@ -2544,6 +2567,103 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Gets the text detection results of a Amazon Rekognition Video analysis
+    # started by StartTextDetection.
+    #
+    # Text detection with Amazon Rekognition Video is an asynchronous
+    # operation. You start text detection by calling StartTextDetection
+    # which returns a job identifier (`JobId`) When the text detection
+    # operation finishes, Amazon Rekognition publishes a completion status
+    # to the Amazon Simple Notification Service topic registered in the
+    # initial call to `StartTextDetection`. To get the results of the text
+    # detection operation, first check that the status value published to
+    # the Amazon SNS topic is `SUCCEEDED`. if so, call `GetTextDetection`
+    # and pass the job identifier (`JobId`) from the initial call of
+    # `StartLabelDetection`.
+    #
+    # `GetTextDetection` returns an array of detected text
+    # (`TextDetections`) sorted by the time the text was detected, up to 50
+    # words per frame of video.
+    #
+    # Each element of the array includes the detected text, the precentage
+    # confidence in the acuracy of the detected text, the time the text was
+    # detected, bounding box information for where the text was located, and
+    # unique identifiers for words and their lines.
+    #
+    # Use MaxResults parameter to limit the number of text detections
+    # returned. If there are more results than specified in `MaxResults`,
+    # the value of `NextToken` in the operation response contains a
+    # pagination token for getting the next set of results. To get the next
+    # page of results, call `GetTextDetection` and populate the `NextToken`
+    # request parameter with the token value returned from the previous call
+    # to `GetTextDetection`.
+    #
+    # @option params [required, String] :job_id
+    #   Job identifier for the label detection operation for which you want
+    #   results returned. You get the job identifer from an initial call to
+    #   `StartTextDetection`.
+    #
+    # @option params [Integer] :max_results
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000.
+    #
+    # @option params [String] :next_token
+    #   If the previous response was incomplete (because there are more labels
+    #   to retrieve), Amazon Rekognition Video returns a pagination token in
+    #   the response. You can use this pagination token to retrieve the next
+    #   set of text.
+    #
+    # @return [Types::GetTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetTextDetectionResponse#job_status #job_status} => String
+    #   * {Types::GetTextDetectionResponse#status_message #status_message} => String
+    #   * {Types::GetTextDetectionResponse#video_metadata #video_metadata} => Types::VideoMetadata
+    #   * {Types::GetTextDetectionResponse#text_detections #text_detections} => Array&lt;Types::TextDetectionResult&gt;
+    #   * {Types::GetTextDetectionResponse#next_token #next_token} => String
+    #   * {Types::GetTextDetectionResponse#text_model_version #text_model_version} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_text_detection({
+    #     job_id: "JobId", # required
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
+    #   resp.status_message #=> String
+    #   resp.video_metadata.codec #=> String
+    #   resp.video_metadata.duration_millis #=> Integer
+    #   resp.video_metadata.format #=> String
+    #   resp.video_metadata.frame_rate #=> Float
+    #   resp.video_metadata.frame_height #=> Integer
+    #   resp.video_metadata.frame_width #=> Integer
+    #   resp.text_detections #=> Array
+    #   resp.text_detections[0].timestamp #=> Integer
+    #   resp.text_detections[0].text_detection.detected_text #=> String
+    #   resp.text_detections[0].text_detection.type #=> String, one of "LINE", "WORD"
+    #   resp.text_detections[0].text_detection.id #=> Integer
+    #   resp.text_detections[0].text_detection.parent_id #=> Integer
+    #   resp.text_detections[0].text_detection.confidence #=> Float
+    #   resp.text_detections[0].text_detection.geometry.bounding_box.width #=> Float
+    #   resp.text_detections[0].text_detection.geometry.bounding_box.height #=> Float
+    #   resp.text_detections[0].text_detection.geometry.bounding_box.left #=> Float
+    #   resp.text_detections[0].text_detection.geometry.bounding_box.top #=> Float
+    #   resp.text_detections[0].text_detection.geometry.polygon #=> Array
+    #   resp.text_detections[0].text_detection.geometry.polygon[0].x #=> Float
+    #   resp.text_detections[0].text_detection.geometry.polygon[0].y #=> Float
+    #   resp.next_token #=> String
+    #   resp.text_model_version #=> String
+    #
+    # @overload get_text_detection(params = {})
+    # @param [Hash] params ({})
+    def get_text_detection(params = {}, options = {})
+      req = build_request(:get_text_detection, params)
+      req.send_request(options)
+    end
+
     # Detects faces in the input image and adds them to the specified
     # collection.
     #
@@ -4228,6 +4348,98 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Starts asynchronous detection of text in a stored video.
+    #
+    # Amazon Rekognition Video can detect text in a video stored in an
+    # Amazon S3 bucket. Use Video to specify the bucket name and the
+    # filename of the video. `StartTextDetection` returns a job identifier
+    # (`JobId`) which you use to get the results of the operation. When text
+    # detection is finished, Amazon Rekognition Video publishes a completion
+    # status to the Amazon Simple Notification Service topic that you
+    # specify in `NotificationChannel`.
+    #
+    # To get the results of the text detection operation, first check that
+    # the status value published to the Amazon SNS topic is `SUCCEEDED`. if
+    # so, call GetTextDetection and pass the job identifier (`JobId`) from
+    # the initial call to `StartTextDetection`.
+    #
+    # @option params [required, Types::Video] :video
+    #   Video file stored in an Amazon S3 bucket. Amazon Rekognition video
+    #   start operations such as StartLabelDetection use `Video` to specify a
+    #   video for analysis. The supported file formats are .mp4, .mov and
+    #   .avi.
+    #
+    # @option params [String] :client_request_token
+    #   Idempotent token used to identify the start request. If you use the
+    #   same token with multiple `StartTextDetection` requests, the same
+    #   `JobId` is returned. Use `ClientRequestToken` to prevent the same job
+    #   from being accidentaly started more than once.
+    #
+    # @option params [Types::NotificationChannel] :notification_channel
+    #   The Amazon Simple Notification Service topic to which Amazon
+    #   Rekognition publishes the completion status of a video analysis
+    #   operation. For more information, see api-video.
+    #
+    # @option params [String] :job_tag
+    #   An identifier returned in the completion status published by your
+    #   Amazon Simple Notification Service topic. For example, you can use
+    #   `JobTag` to group related jobs and identify them in the completion
+    #   notification.
+    #
+    # @option params [Types::StartTextDetectionFilters] :filters
+    #   Optional parameters that let you set criteria the text must meet to be
+    #   included in your response.
+    #
+    # @return [Types::StartTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartTextDetectionResponse#job_id #job_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_text_detection({
+    #     video: { # required
+    #       s3_object: {
+    #         bucket: "S3Bucket",
+    #         name: "S3ObjectName",
+    #         version: "S3ObjectVersion",
+    #       },
+    #     },
+    #     client_request_token: "ClientRequestToken",
+    #     notification_channel: {
+    #       sns_topic_arn: "SNSTopicArn", # required
+    #       role_arn: "RoleArn", # required
+    #     },
+    #     job_tag: "JobTag",
+    #     filters: {
+    #       word_filter: {
+    #         min_confidence: 1.0,
+    #         min_bounding_box_height: 1.0,
+    #         min_bounding_box_width: 1.0,
+    #       },
+    #       regions_of_interest: [
+    #         {
+    #           bounding_box: {
+    #             width: 1.0,
+    #             height: 1.0,
+    #             left: 1.0,
+    #             top: 1.0,
+    #           },
+    #         },
+    #       ],
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_id #=> String
+    #
+    # @overload start_text_detection(params = {})
+    # @param [Hash] params ({})
+    def start_text_detection(params = {}, options = {})
+      req = build_request(:start_text_detection, params)
+      req.send_request(options)
+    end
+
     # Stops a running model. The operation might take a while to complete.
     # To check the current status, call DescribeProjectVersions.
     #
@@ -4293,7 +4505,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.33.0'
+      context[:gem_version] = '1.34.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-rekognition/client_api.rb

@@ -20,6 +20,8 @@ module Aws::Rekognition
     Beard = Shapes::StructureShape.new(name: 'Beard')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     BoundingBox = Shapes::StructureShape.new(name: 'BoundingBox')
+    BoundingBoxHeight = Shapes::FloatShape.new(name: 'BoundingBoxHeight')
+    BoundingBoxWidth = Shapes::FloatShape.new(name: 'BoundingBoxWidth')
     Celebrity = Shapes::StructureShape.new(name: 'Celebrity')
     CelebrityDetail = Shapes::StructureShape.new(name: 'CelebrityDetail')
     CelebrityList = Shapes::ListShape.new(name: 'CelebrityList')
@@ -76,8 +78,10 @@ module Aws::Rekognition
     DetectLabelsResponse = Shapes::StructureShape.new(name: 'DetectLabelsResponse')
     DetectModerationLabelsRequest = Shapes::StructureShape.new(name: 'DetectModerationLabelsRequest')
     DetectModerationLabelsResponse = Shapes::StructureShape.new(name: 'DetectModerationLabelsResponse')
+    DetectTextFilters = Shapes::StructureShape.new(name: 'DetectTextFilters')
     DetectTextRequest = Shapes::StructureShape.new(name: 'DetectTextRequest')
     DetectTextResponse = Shapes::StructureShape.new(name: 'DetectTextResponse')
+    DetectionFilter = Shapes::StructureShape.new(name: 'DetectionFilter')
     Emotion = Shapes::StructureShape.new(name: 'Emotion')
     EmotionName = Shapes::StringShape.new(name: 'EmotionName')
     Emotions = Shapes::ListShape.new(name: 'Emotions')
@@ -121,6 +125,8 @@ module Aws::Rekognition
     GetLabelDetectionResponse = Shapes::StructureShape.new(name: 'GetLabelDetectionResponse')
     GetPersonTrackingRequest = Shapes::StructureShape.new(name: 'GetPersonTrackingRequest')
     GetPersonTrackingResponse = Shapes::StructureShape.new(name: 'GetPersonTrackingResponse')
+    GetTextDetectionRequest = Shapes::StructureShape.new(name: 'GetTextDetectionRequest')
+    GetTextDetectionResponse = Shapes::StructureShape.new(name: 'GetTextDetectionResponse')
     GroundTruthManifest = Shapes::StructureShape.new(name: 'GroundTruthManifest')
     HumanLoopActivationConditionsEvaluationResults = Shapes::StringShape.new(name: 'HumanLoopActivationConditionsEvaluationResults')
     HumanLoopActivationOutput = Shapes::StructureShape.new(name: 'HumanLoopActivationOutput')
@@ -210,6 +216,8 @@ module Aws::Rekognition
     Reasons = Shapes::ListShape.new(name: 'Reasons')
     RecognizeCelebritiesRequest = Shapes::StructureShape.new(name: 'RecognizeCelebritiesRequest')
     RecognizeCelebritiesResponse = Shapes::StructureShape.new(name: 'RecognizeCelebritiesResponse')
+    RegionOfInterest = Shapes::StructureShape.new(name: 'RegionOfInterest')
+    RegionsOfInterest = Shapes::ListShape.new(name: 'RegionsOfInterest')
     RekognitionUniqueId = Shapes::StringShape.new(name: 'RekognitionUniqueId')
     ResourceAlreadyExistsException = Shapes::StructureShape.new(name: 'ResourceAlreadyExistsException')
     ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
@@ -243,6 +251,9 @@ module Aws::Rekognition
     StartProjectVersionResponse = Shapes::StructureShape.new(name: 'StartProjectVersionResponse')
     StartStreamProcessorRequest = Shapes::StructureShape.new(name: 'StartStreamProcessorRequest')
     StartStreamProcessorResponse = Shapes::StructureShape.new(name: 'StartStreamProcessorResponse')
+    StartTextDetectionFilters = Shapes::StructureShape.new(name: 'StartTextDetectionFilters')
+    StartTextDetectionRequest = Shapes::StructureShape.new(name: 'StartTextDetectionRequest')
+    StartTextDetectionResponse = Shapes::StructureShape.new(name: 'StartTextDetectionResponse')
     StatusMessage = Shapes::StringShape.new(name: 'StatusMessage')
     StopProjectVersionRequest = Shapes::StructureShape.new(name: 'StopProjectVersionRequest')
     StopProjectVersionResponse = Shapes::StructureShape.new(name: 'StopProjectVersionResponse')
@@ -263,6 +274,8 @@ module Aws::Rekognition
     TestingDataResult = Shapes::StructureShape.new(name: 'TestingDataResult')
     TextDetection = Shapes::StructureShape.new(name: 'TextDetection')
     TextDetectionList = Shapes::ListShape.new(name: 'TextDetectionList')
+    TextDetectionResult = Shapes::StructureShape.new(name: 'TextDetectionResult')
+    TextDetectionResults = Shapes::ListShape.new(name: 'TextDetectionResults')
     TextTypes = Shapes::StringShape.new(name: 'TextTypes')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
     Timestamp = Shapes::IntegerShape.new(name: 'Timestamp')
@@ -507,12 +520,23 @@ module Aws::Rekognition
     DetectModerationLabelsResponse.add_member(:human_loop_activation_output, Shapes::ShapeRef.new(shape: HumanLoopActivationOutput, location_name: "HumanLoopActivationOutput"))
     DetectModerationLabelsResponse.struct_class = Types::DetectModerationLabelsResponse
 
+    DetectTextFilters.add_member(:word_filter, Shapes::ShapeRef.new(shape: DetectionFilter, location_name: "WordFilter"))
+    DetectTextFilters.add_member(:regions_of_interest, Shapes::ShapeRef.new(shape: RegionsOfInterest, location_name: "RegionsOfInterest"))
+    DetectTextFilters.struct_class = Types::DetectTextFilters
+
     DetectTextRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
+    DetectTextRequest.add_member(:filters, Shapes::ShapeRef.new(shape: DetectTextFilters, location_name: "Filters"))
     DetectTextRequest.struct_class = Types::DetectTextRequest
 
     DetectTextResponse.add_member(:text_detections, Shapes::ShapeRef.new(shape: TextDetectionList, location_name: "TextDetections"))
+    DetectTextResponse.add_member(:text_model_version, Shapes::ShapeRef.new(shape: String, location_name: "TextModelVersion"))
     DetectTextResponse.struct_class = Types::DetectTextResponse
 
+    DetectionFilter.add_member(:min_confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "MinConfidence"))
+    DetectionFilter.add_member(:min_bounding_box_height, Shapes::ShapeRef.new(shape: BoundingBoxHeight, location_name: "MinBoundingBoxHeight"))
+    DetectionFilter.add_member(:min_bounding_box_width, Shapes::ShapeRef.new(shape: BoundingBoxWidth, location_name: "MinBoundingBoxWidth"))
+    DetectionFilter.struct_class = Types::DetectionFilter
+
     Emotion.add_member(:type, Shapes::ShapeRef.new(shape: EmotionName, location_name: "Type"))
     Emotion.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
     Emotion.struct_class = Types::Emotion
@@ -679,6 +703,19 @@ module Aws::Rekognition
     GetPersonTrackingResponse.add_member(:persons, Shapes::ShapeRef.new(shape: PersonDetections, location_name: "Persons"))
     GetPersonTrackingResponse.struct_class = Types::GetPersonTrackingResponse
 
+    GetTextDetectionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
+    GetTextDetectionRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    GetTextDetectionRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
+    GetTextDetectionRequest.struct_class = Types::GetTextDetectionRequest
+
+    GetTextDetectionResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: VideoJobStatus, location_name: "JobStatus"))
+    GetTextDetectionResponse.add_member(:status_message, Shapes::ShapeRef.new(shape: StatusMessage, location_name: "StatusMessage"))
+    GetTextDetectionResponse.add_member(:video_metadata, Shapes::ShapeRef.new(shape: VideoMetadata, location_name: "VideoMetadata"))
+    GetTextDetectionResponse.add_member(:text_detections, Shapes::ShapeRef.new(shape: TextDetectionResults, location_name: "TextDetections"))
+    GetTextDetectionResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
+    GetTextDetectionResponse.add_member(:text_model_version, Shapes::ShapeRef.new(shape: String, location_name: "TextModelVersion"))
+    GetTextDetectionResponse.struct_class = Types::GetTextDetectionResponse
+
     GroundTruthManifest.add_member(:s3_object, Shapes::ShapeRef.new(shape: S3Object, location_name: "S3Object"))
     GroundTruthManifest.struct_class = Types::GroundTruthManifest
 
@@ -873,6 +910,11 @@ module Aws::Rekognition
     RecognizeCelebritiesResponse.add_member(:orientation_correction, Shapes::ShapeRef.new(shape: OrientationCorrection, location_name: "OrientationCorrection"))
     RecognizeCelebritiesResponse.struct_class = Types::RecognizeCelebritiesResponse
 
+    RegionOfInterest.add_member(:bounding_box, Shapes::ShapeRef.new(shape: BoundingBox, location_name: "BoundingBox"))
+    RegionOfInterest.struct_class = Types::RegionOfInterest
+
+    RegionsOfInterest.member = Shapes::ShapeRef.new(shape: RegionOfInterest)
+
     S3Object.add_member(:bucket, Shapes::ShapeRef.new(shape: S3Bucket, location_name: "Bucket"))
     S3Object.add_member(:name, Shapes::ShapeRef.new(shape: S3ObjectName, location_name: "Name"))
     S3Object.add_member(:version, Shapes::ShapeRef.new(shape: S3ObjectVersion, location_name: "Version"))
@@ -977,6 +1019,20 @@ module Aws::Rekognition
 
     StartStreamProcessorResponse.struct_class = Types::StartStreamProcessorResponse
 
+    StartTextDetectionFilters.add_member(:word_filter, Shapes::ShapeRef.new(shape: DetectionFilter, location_name: "WordFilter"))
+    StartTextDetectionFilters.add_member(:regions_of_interest, Shapes::ShapeRef.new(shape: RegionsOfInterest, location_name: "RegionsOfInterest"))
+    StartTextDetectionFilters.struct_class = Types::StartTextDetectionFilters
+
+    StartTextDetectionRequest.add_member(:video, Shapes::ShapeRef.new(shape: Video, required: true, location_name: "Video"))
+    StartTextDetectionRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken"))
+    StartTextDetectionRequest.add_member(:notification_channel, Shapes::ShapeRef.new(shape: NotificationChannel, location_name: "NotificationChannel"))
+    StartTextDetectionRequest.add_member(:job_tag, Shapes::ShapeRef.new(shape: JobTag, location_name: "JobTag"))
+    StartTextDetectionRequest.add_member(:filters, Shapes::ShapeRef.new(shape: StartTextDetectionFilters, location_name: "Filters"))
+    StartTextDetectionRequest.struct_class = Types::StartTextDetectionRequest
+
+    StartTextDetectionResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "JobId"))
+    StartTextDetectionResponse.struct_class = Types::StartTextDetectionResponse
+
     StopProjectVersionRequest.add_member(:project_version_arn, Shapes::ShapeRef.new(shape: ProjectVersionArn, required: true, location_name: "ProjectVersionArn"))
     StopProjectVersionRequest.struct_class = Types::StopProjectVersionRequest
 
@@ -1028,6 +1084,12 @@ module Aws::Rekognition
 
     TextDetectionList.member = Shapes::ShapeRef.new(shape: TextDetection)
 
+    TextDetectionResult.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Timestamp"))
+    TextDetectionResult.add_member(:text_detection, Shapes::ShapeRef.new(shape: TextDetection, location_name: "TextDetection"))
+    TextDetectionResult.struct_class = Types::TextDetectionResult
+
+    TextDetectionResults.member = Shapes::ShapeRef.new(shape: TextDetectionResult)
+
     TrainingData.add_member(:assets, Shapes::ShapeRef.new(shape: Assets, location_name: "Assets"))
     TrainingData.struct_class = Types::TrainingData
 
@@ -1486,6 +1548,27 @@ module Aws::Rekognition
         )
       end)
 
+      api.add_operation(:get_text_detection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetTextDetection"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetTextDetectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetTextDetectionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidPaginationTokenException)
+        o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:index_faces, Seahorse::Model::Operation.new.tap do |o|
         o.name = "IndexFaces"
         o.http_method = "POST"
@@ -1747,6 +1830,23 @@ module Aws::Rekognition
         o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
       end)
 
+      api.add_operation(:start_text_detection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartTextDetection"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: StartTextDetectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartTextDetectionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: IdempotentParameterMismatchException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidS3ObjectException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+        o.errors << Shapes::ShapeRef.new(shape: VideoTooLargeException)
+        o.errors << Shapes::ShapeRef.new(shape: ProvisionedThroughputExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+      end)
+
       api.add_operation(:stop_project_version, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StopProjectVersion"
         o.http_method = "POST"

data/lib/aws-sdk-rekognition/types.rb

@@ -97,6 +97,16 @@ module Aws::Rekognition
     #
     #  </note>
     #
+    # @note When making an API call, you may pass BoundingBox
+    #   data as a hash:
+    #
+    #       {
+    #         width: 1.0,
+    #         height: 1.0,
+    #         left: 1.0,
+    #         top: 1.0,
+    #       }
+    #
     # @!attribute [rw] width
     #   Width of the bounding box as a ratio of the overall image width.
     #   @return [Float]
@@ -1297,6 +1307,48 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # A set of optional parameters that you can use to set the criteria that
+    # the text must meet to be included in your response. `WordFilter` looks
+    # at a word’s height, width, and minimum confidence. `RegionOfInterest`
+    # lets you set a specific region of the image to look for text in.
+    #
+    # @note When making an API call, you may pass DetectTextFilters
+    #   data as a hash:
+    #
+    #       {
+    #         word_filter: {
+    #           min_confidence: 1.0,
+    #           min_bounding_box_height: 1.0,
+    #           min_bounding_box_width: 1.0,
+    #         },
+    #         regions_of_interest: [
+    #           {
+    #             bounding_box: {
+    #               width: 1.0,
+    #               height: 1.0,
+    #               left: 1.0,
+    #               top: 1.0,
+    #             },
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] word_filter
+    #   A set of parameters that allow you to filter out certain results
+    #   from your returned results.
+    #   @return [Types::DetectionFilter]
+    #
+    # @!attribute [rw] regions_of_interest
+    #   A Filter focusing on a certain area of the image. Uses a
+    #   `BoundingBox` object to set the region of the image.
+    #   @return [Array<Types::RegionOfInterest>]
+    #
+    class DetectTextFilters < Struct.new(
+      :word_filter,
+      :regions_of_interest)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DetectTextRequest
     #   data as a hash:
     #
@@ -1309,6 +1361,23 @@ module Aws::Rekognition
     #             version: "S3ObjectVersion",
     #           },
     #         },
+    #         filters: {
+    #           word_filter: {
+    #             min_confidence: 1.0,
+    #             min_bounding_box_height: 1.0,
+    #             min_bounding_box_width: 1.0,
+    #           },
+    #           regions_of_interest: [
+    #             {
+    #               bounding_box: {
+    #                 width: 1.0,
+    #                 height: 1.0,
+    #                 left: 1.0,
+    #                 top: 1.0,
+    #               },
+    #             },
+    #           ],
+    #         },
     #       }
     #
     # @!attribute [rw] image
@@ -1322,8 +1391,14 @@ module Aws::Rekognition
     #   developer guide.
     #   @return [Types::Image]
     #
+    # @!attribute [rw] filters
+    #   Optional parameters that let you set the criteria that the text must
+    #   meet to be included in your response.
+    #   @return [Types::DetectTextFilters]
+    #
     class DetectTextRequest < Struct.new(
-      :image)
+      :image,
+      :filters)
       include Aws::Structure
     end
 
@@ -1331,8 +1406,51 @@ module Aws::Rekognition
     #   An array of text that was detected in the input image.
     #   @return [Array<Types::TextDetection>]
     #
+    # @!attribute [rw] text_model_version
+    #   The model version used to detect text.
+    #   @return [String]
+    #
     class DetectTextResponse < Struct.new(
-      :text_detections)
+      :text_detections,
+      :text_model_version)
+      include Aws::Structure
+    end
+
+    # A set of parameters that allow you to filter out certain results from
+    # your returned results.
+    #
+    # @note When making an API call, you may pass DetectionFilter
+    #   data as a hash:
+    #
+    #       {
+    #         min_confidence: 1.0,
+    #         min_bounding_box_height: 1.0,
+    #         min_bounding_box_width: 1.0,
+    #       }
+    #
+    # @!attribute [rw] min_confidence
+    #   Sets confidence of word detection. Words with detection confidence
+    #   below this will be excluded from the result. Values should be
+    #   between 0.5 and 1 as Text in Video will not return any result below
+    #   0.5.
+    #   @return [Float]
+    #
+    # @!attribute [rw] min_bounding_box_height
+    #   Sets the minimum height of the word bounding box. Words with
+    #   bounding box heights lesser than this value will be excluded from
+    #   the result. Value is relative to the video frame height.
+    #   @return [Float]
+    #
+    # @!attribute [rw] min_bounding_box_width
+    #   Sets the minimum width of the word bounding box. Words with bounding
+    #   boxes widths lesser than this value will be excluded from the
+    #   result. Value is relative to the video frame width.
+    #   @return [Float]
+    #
+    class DetectionFilter < Struct.new(
+      :min_confidence,
+      :min_bounding_box_height,
+      :min_bounding_box_width)
       include Aws::Structure
     end
 
@@ -1642,7 +1760,7 @@ module Aws::Rekognition
     #
     # @!attribute [rw] face_match_threshold
     #   Minimum face match confidence score that must be met to return a
-    #   result for a recognized face. Default is 70. 0 is the lowest
+    #   result for a recognized face. Default is 80. 0 is the lowest
     #   confidence. 100 is the highest confidence.
     #   @return [Float]
     #
@@ -2223,6 +2341,82 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetTextDetectionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #         max_results: 1,
+    #         next_token: "PaginationToken",
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   Job identifier for the label detection operation for which you want
+    #   results returned. You get the job identifer from an initial call to
+    #   `StartTextDetection`.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   If the previous response was incomplete (because there are more
+    #   labels to retrieve), Amazon Rekognition Video returns a pagination
+    #   token in the response. You can use this pagination token to retrieve
+    #   the next set of text.
+    #   @return [String]
+    #
+    class GetTextDetectionRequest < Struct.new(
+      :job_id,
+      :max_results,
+      :next_token)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_status
+    #   Current status of the text detection job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_message
+    #   If the job fails, `StatusMessage` provides a descriptive error
+    #   message.
+    #   @return [String]
+    #
+    # @!attribute [rw] video_metadata
+    #   Information about a video that Amazon Rekognition analyzed.
+    #   `Videometadata` is returned in every page of paginated responses
+    #   from a Amazon Rekognition video operation.
+    #   @return [Types::VideoMetadata]
+    #
+    # @!attribute [rw] text_detections
+    #   An array of text detected in the video. Each element contains the
+    #   detected text, the time in milliseconds from the start of the video
+    #   that the text was detected, and where it was detected on the screen.
+    #   @return [Array<Types::TextDetectionResult>]
+    #
+    # @!attribute [rw] next_token
+    #   If the response is truncated, Amazon Rekognition Video returns this
+    #   token that you can use in the subsequent request to retrieve the
+    #   next set of text.
+    #   @return [String]
+    #
+    # @!attribute [rw] text_model_version
+    #   Version number of the text detection model that was used to detect
+    #   text.
+    #   @return [String]
+    #
+    class GetTextDetectionResponse < Struct.new(
+      :job_status,
+      :status_message,
+      :video_metadata,
+      :text_detections,
+      :next_token,
+      :text_model_version)
+      include Aws::Structure
+    end
+
     # The S3 bucket that contains the Ground Truth manifest file.
     #
     # @note When making an API call, you may pass GroundTruthManifest
@@ -3256,6 +3450,35 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Specifies a location within the frame that Rekognition checks for
+    # text. Uses a `BoundingBox` object to set a region of the screen.
+    #
+    # A word is included in the region if the word is more than half in that
+    # region. If there is more than one region, the word will be compared
+    # with all regions of the screen. Any word more than half in a region is
+    # kept in the results.
+    #
+    # @note When making an API call, you may pass RegionOfInterest
+    #   data as a hash:
+    #
+    #       {
+    #         bounding_box: {
+    #           width: 1.0,
+    #           height: 1.0,
+    #           left: 1.0,
+    #           top: 1.0,
+    #         },
+    #       }
+    #
+    # @!attribute [rw] bounding_box
+    #   The box representing a region of interest on screen.
+    #   @return [Types::BoundingBox]
+    #
+    class RegionOfInterest < Struct.new(
+      :bounding_box)
+      include Aws::Structure
+    end
+
     # Provides the S3 bucket name and object name.
     #
     # The region for the S3 bucket containing the S3 object must match the
@@ -3941,6 +4164,135 @@ module Aws::Rekognition
 
     class StartStreamProcessorResponse < Aws::EmptyStructure; end
 
+    # Set of optional parameters that let you set the criteria text must
+    # meet to be included in your response. `WordFilter` looks at a word's
+    # height, width and minimum confidence. `RegionOfInterest` lets you set
+    # a specific region of the screen to look for text in.
+    #
+    # @note When making an API call, you may pass StartTextDetectionFilters
+    #   data as a hash:
+    #
+    #       {
+    #         word_filter: {
+    #           min_confidence: 1.0,
+    #           min_bounding_box_height: 1.0,
+    #           min_bounding_box_width: 1.0,
+    #         },
+    #         regions_of_interest: [
+    #           {
+    #             bounding_box: {
+    #               width: 1.0,
+    #               height: 1.0,
+    #               left: 1.0,
+    #               top: 1.0,
+    #             },
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] word_filter
+    #   Filters focusing on qualities of the text, such as confidence or
+    #   size.
+    #   @return [Types::DetectionFilter]
+    #
+    # @!attribute [rw] regions_of_interest
+    #   Filter focusing on a certain area of the frame. Uses a `BoundingBox`
+    #   object to set the region of the screen.
+    #   @return [Array<Types::RegionOfInterest>]
+    #
+    class StartTextDetectionFilters < Struct.new(
+      :word_filter,
+      :regions_of_interest)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass StartTextDetectionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         video: { # required
+    #           s3_object: {
+    #             bucket: "S3Bucket",
+    #             name: "S3ObjectName",
+    #             version: "S3ObjectVersion",
+    #           },
+    #         },
+    #         client_request_token: "ClientRequestToken",
+    #         notification_channel: {
+    #           sns_topic_arn: "SNSTopicArn", # required
+    #           role_arn: "RoleArn", # required
+    #         },
+    #         job_tag: "JobTag",
+    #         filters: {
+    #           word_filter: {
+    #             min_confidence: 1.0,
+    #             min_bounding_box_height: 1.0,
+    #             min_bounding_box_width: 1.0,
+    #           },
+    #           regions_of_interest: [
+    #             {
+    #               bounding_box: {
+    #                 width: 1.0,
+    #                 height: 1.0,
+    #                 left: 1.0,
+    #                 top: 1.0,
+    #               },
+    #             },
+    #           ],
+    #         },
+    #       }
+    #
+    # @!attribute [rw] video
+    #   Video file stored in an Amazon S3 bucket. Amazon Rekognition video
+    #   start operations such as StartLabelDetection use `Video` to specify
+    #   a video for analysis. The supported file formats are .mp4, .mov and
+    #   .avi.
+    #   @return [Types::Video]
+    #
+    # @!attribute [rw] client_request_token
+    #   Idempotent token used to identify the start request. If you use the
+    #   same token with multiple `StartTextDetection` requests, the same
+    #   `JobId` is returned. Use `ClientRequestToken` to prevent the same
+    #   job from being accidentaly started more than once.
+    #   @return [String]
+    #
+    # @!attribute [rw] notification_channel
+    #   The Amazon Simple Notification Service topic to which Amazon
+    #   Rekognition publishes the completion status of a video analysis
+    #   operation. For more information, see api-video.
+    #   @return [Types::NotificationChannel]
+    #
+    # @!attribute [rw] job_tag
+    #   An identifier returned in the completion status published by your
+    #   Amazon Simple Notification Service topic. For example, you can use
+    #   `JobTag` to group related jobs and identify them in the completion
+    #   notification.
+    #   @return [String]
+    #
+    # @!attribute [rw] filters
+    #   Optional parameters that let you set criteria the text must meet to
+    #   be included in your response.
+    #   @return [Types::StartTextDetectionFilters]
+    #
+    class StartTextDetectionRequest < Struct.new(
+      :video,
+      :client_request_token,
+      :notification_channel,
+      :job_tag,
+      :filters)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] job_id
+    #   Identifier for the text detection job. Use `JobId` to identify the
+    #   job in a subsequent call to `GetTextDetection`.
+    #   @return [String]
+    #
+    class StartTextDetectionResponse < Struct.new(
+      :job_id)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StopProjectVersionRequest
     #   data as a hash:
     #
@@ -4227,6 +4579,25 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Information about text detected in a video. Incudes the detected text,
+    # the time in milliseconds from the start of the video that the text was
+    # detected, and where it was detected on the screen.
+    #
+    # @!attribute [rw] timestamp
+    #   The time, in milliseconds from the start of the video, that the text
+    #   was detected.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] text_detection
+    #   Details about text detected in a video.
+    #   @return [Types::TextDetection]
+    #
+    class TextDetectionResult < Struct.new(
+      :timestamp,
+      :text_detection)
+      include Aws::Structure
+    end
+
     # The dataset used for training.
     #
     # @note When making an API call, you may pass TrainingData

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core