aws-sdk-rekognition 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31fc3baa314f96f7e71daa41e992169fb7d8fdd4
-  data.tar.gz: c4de58b98f35bd95c22c3d3ae4dc8dcb1bbc8158
+  metadata.gz: bb4d2c32162a1218486c97b8b9cd0b69416d2f83
+  data.tar.gz: 98906ce7278a97292d947ae339e1aa31ec34dbeb
 SHA512:
-  metadata.gz: 0413f61a60dbdbbfbe10cd571c6437d392797e773e83abbf872d4c58718b83881dd4def06ce8fe6d2c14d28b762eafed5ec610003c3c2a13f3dfc33d836dcd3b
-  data.tar.gz: 23b91398429ffd8a3ecf00ba27b931fa67b4ca1ee3b529204de3510105d17bd8b757b39e491afb778426a3c2c54cee1ad1c0b5fdcad929f180a868e71a2f7702
+  metadata.gz: e141b4a26cf096429e56365ce66d721dd9b06c1378731279011185cadaa50ebfed8d5af67b58378d994df4acd35a0f669b316c07b30d5b91279bd8637b4e40dd
+  data.tar.gz: 3df162b8063857211c31c83731a605d22cc45ca5880e5af948da2c2916f74f4b5cb164328e987c0a406d5d93938910fda9a2e70993eca825f7f982bb80683fe2

data/lib/aws-sdk-rekognition.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.16.0'
+  GEM_VERSION = '1.17.0'
 
 end

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

@@ -408,7 +408,7 @@ module Aws::Rekognition
     end
 
     # Creates a collection in an AWS Region. You can add faces to the
-    # collection using the operation.
+    # collection using the IndexFaces operation.
     #
     # For example, you might create collections, one for each of your
     # application users. A user can then index faces using the `IndexFaces`
@@ -480,11 +480,12 @@ module Aws::Rekognition
     # criteria in `Settings`. For example, the collection containing faces
     # that you want to recognize. Use `Name` to assign an identifier for the
     # stream processor. You use `Name` to manage the stream processor. For
-    # example, you can start processing the source video by calling with the
-    # `Name` field.
+    # example, you can start processing the source video by calling
+    # StartStreamProcessor with the `Name` field.
     #
-    # After you have finished analyzing a streaming video, use to stop
-    # processing. You can delete the stream processor by calling .
+    # After you have finished analyzing a streaming video, use
+    # StopStreamProcessor to stop processing. You can delete the stream
+    # processor by calling DeleteStreamProcessor.
     #
     # @option params [required, Types::StreamProcessorInput] :input
     #   Kinesis video stream stream that provides the source streaming video.
@@ -499,7 +500,8 @@ module Aws::Rekognition
     # @option params [required, String] :name
     #   An identifier you assign to the stream processor. You can use `Name`
     #   to manage the stream processor. For example, you can get the current
-    #   status of the stream processor by calling . `Name` is idempotent.
+    #   status of the stream processor by calling DescribeStreamProcessor.
+    #   `Name` is idempotent.
     #
     # @option params [required, Types::StreamProcessorSettings] :settings
     #   Face recognition input parameters to be used by the stream processor.
@@ -647,9 +649,10 @@ module Aws::Rekognition
     end
 
     # Deletes the stream processor identified by `Name`. You assign the
-    # value for `Name` when you create the stream processor with . You might
-    # not be able to use the same name for a stream processor for a few
-    # seconds after calling `DeleteStreamProcessor`.
+    # value for `Name` when you create the stream processor with
+    # CreateStreamProcessor. You might not be able to use the same name for
+    # a stream processor for a few seconds after calling
+    # `DeleteStreamProcessor`.
     #
     # @option params [required, String] :name
     #   The name of the stream processor you want to delete.
@@ -707,10 +710,10 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
-    # Provides information about a stream processor created by . You can get
-    # information about the input and output streams, the input parameters
-    # for the face recognition being performed, and the current status of
-    # the stream processor.
+    # Provides information about a stream processor created by
+    # CreateStreamProcessor. You can get information about the input and
+    # output streams, the input parameters for the face recognition being
+    # performed, and the current status of the stream processor.
     #
     # @option params [required, String] :name
     #   Name of the stream processor for which you want information.
@@ -981,7 +984,7 @@ module Aws::Rekognition
     # In response, the API returns an array of labels. In addition, the
     # response also includes the orientation correction. Optionally, you can
     # specify `MinConfidence` to control the confidence threshold for the
-    # labels returned. The default is 50%. You can also add the `MaxLabels`
+    # labels returned. The default is 55%. You can also add the `MaxLabels`
     # parameter to limit the number of labels returned.
     #
     # <note markdown="1"> If the object detected is a person, the operation doesn't provide the
@@ -990,9 +993,9 @@ module Aws::Rekognition
     #  </note>
     #
     # `DetectLabels` returns bounding boxes for instances of common object
-    # labels in an array of objects. An `Instance` object contains a object,
-    # for the location of the label on the image. It also includes the
-    # confidence by which the bounding box was detected.
+    # labels in an array of Instance objects. An `Instance` object contains
+    # a BoundingBox object, for the location of the label on the image. It
+    # also includes the confidence by which the bounding box was detected.
     #
     # `DetectLabels` also returns a hierarchical taxonomy of detected
     # labels. For example, a detected car might be assigned the label *car*.
@@ -1024,7 +1027,7 @@ module Aws::Rekognition
     #   than this specified value.
     #
     #   If `MinConfidence` is not specified, the operation returns labels with
-    #   a confidence values greater than or equal to 50 percent.
+    #   a confidence values greater than or equal to 55 percent.
     #
     # @return [Types::DetectLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1133,6 +1136,7 @@ module Aws::Rekognition
     # @return [Types::DetectModerationLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DetectModerationLabelsResponse#moderation_labels #moderation_labels} => Array&lt;Types::ModerationLabel&gt;
+    #   * {Types::DetectModerationLabelsResponse#moderation_model_version #moderation_model_version} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1154,6 +1158,7 @@ module Aws::Rekognition
     #   resp.moderation_labels[0].confidence #=> Float
     #   resp.moderation_labels[0].name #=> String
     #   resp.moderation_labels[0].parent_name #=> String
+    #   resp.moderation_model_version #=> String
     #
     # @overload detect_moderation_labels(params = {})
     # @param [Hash] params ({})
@@ -1172,9 +1177,10 @@ module Aws::Rekognition
     # not supported. The image must be either a .png or .jpeg formatted
     # file.
     #
-    # The `DetectText` operation returns text in an array of elements,
-    # `TextDetections`. Each `TextDetection` element provides information
-    # about a single word or line of text that was detected in the image.
+    # The `DetectText` operation returns text in an array of TextDetection
+    # elements, `TextDetections`. Each `TextDetection` element provides
+    # information about a single word or line of text that was detected in
+    # the image.
     #
     # A word is one or more ISO basic latin script characters that are not
     # separated by spaces. `DetectText` can detect up to 50 words in an
@@ -1257,7 +1263,8 @@ module Aws::Rekognition
     #
     # @option params [required, String] :id
     #   The ID for the celebrity. You get the celebrity ID from a call to the
-    #   operation, which recognizes celebrities in an image.
+    #   RecognizeCelebrities operation, which recognizes celebrities in an
+    #   image.
     #
     # @return [Types::GetCelebrityInfoResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1284,16 +1291,16 @@ module Aws::Rekognition
     end
 
     # Gets the celebrity recognition results for a Amazon Rekognition Video
-    # analysis started by .
+    # analysis started by StartCelebrityRecognition.
     #
     # Celebrity recognition in a video is an asynchronous operation.
-    # Analysis is started by a call to which returns a job identifier
-    # (`JobId`). When the celebrity recognition operation finishes, Amazon
-    # Rekognition Video publishes a completion status to the Amazon Simple
-    # Notification Service topic registered in the initial call to
-    # `StartCelebrityRecognition`. To get the results of the celebrity
-    # recognition analysis, first check that the status value published to
-    # the Amazon SNS topic is `SUCCEEDED`. If so, call
+    # Analysis is started by a call to StartCelebrityRecognition which
+    # returns a job identifier (`JobId`). When the celebrity recognition
+    # operation finishes, Amazon Rekognition Video publishes a completion
+    # status to the Amazon Simple Notification Service topic registered in
+    # the initial call to `StartCelebrityRecognition`. To get the results of
+    # the celebrity recognition analysis, first check that the status value
+    # published to the Amazon SNS topic is `SUCCEEDED`. If so, call
     # `GetCelebrityDetection` and pass the job identifier (`JobId`) from the
     # initial call to `StartCelebrityDetection`.
     #
@@ -1301,9 +1308,10 @@ module Aws::Rekognition
     # Rekognition Developer Guide.
     #
     # `GetCelebrityRecognition` returns detected celebrities and the time(s)
-    # they are detected in an array (`Celebrities`) of objects. Each
-    # `CelebrityRecognition` contains information about the celebrity in a
-    # object and the time, `Timestamp`, the celebrity was detected.
+    # they are detected in an array (`Celebrities`) of CelebrityRecognition
+    # objects. Each `CelebrityRecognition` contains information about the
+    # celebrity in a CelebrityDetail object and the time, `Timestamp`, the
+    # celebrity was detected.
     #
     # <note markdown="1"> `GetCelebrityRecognition` only returns the default facial attributes
     # (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
@@ -1319,8 +1327,8 @@ module Aws::Rekognition
     #
     # The `CelebrityDetail` object includes the celebrity identifer and
     # additional information urls. If you don't store the additional
-    # information urls, you can get them later by calling with the celebrity
-    # identifer.
+    # information urls, you can get them later by calling GetCelebrityInfo
+    # with the celebrity identifer.
     #
     # No information is returned for faces not recognized as celebrities.
     #
@@ -1436,24 +1444,25 @@ module Aws::Rekognition
     end
 
     # Gets the content moderation analysis results for a Amazon Rekognition
-    # Video analysis started by .
+    # Video analysis started by StartContentModeration.
     #
     # Content moderation analysis of a video is an asynchronous operation.
-    # You start analysis by calling . which returns a job identifier
-    # (`JobId`). When analysis finishes, Amazon Rekognition Video publishes
-    # a completion status to the Amazon Simple Notification Service topic
-    # registered in the initial call to `StartContentModeration`. To get the
-    # results of the content moderation analysis, first check that the
-    # status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
-    # call `GetCelebrityDetection` and pass the job identifier (`JobId`)
-    # from the initial call to `StartCelebrityDetection`.
+    # You start analysis by calling StartContentModeration. which returns a
+    # job identifier (`JobId`). When analysis finishes, Amazon Rekognition
+    # Video publishes a completion status to the Amazon Simple Notification
+    # Service topic registered in the initial call to
+    # `StartContentModeration`. To get the results of the content moderation
+    # analysis, first check that the status value published to the Amazon
+    # SNS topic is `SUCCEEDED`. If so, call `GetCelebrityDetection` and pass
+    # the job identifier (`JobId`) from the initial call to
+    # `StartCelebrityDetection`.
     #
     # For more information, see Working with Stored Videos in the Amazon
     # Rekognition Devlopers Guide.
     #
     # `GetContentModeration` returns detected content moderation labels, and
     # the time they are detected, in an array, `ModerationLabels`, of
-    # objects.
+    # ContentModerationDetection objects.
     #
     # By default, the moderated labels are returned sorted by time, in
     # milliseconds from the start of the video. You can also sort them by
@@ -1536,17 +1545,18 @@ module Aws::Rekognition
     end
 
     # Gets face detection results for a Amazon Rekognition Video analysis
-    # started by .
+    # started by StartFaceDetection.
     #
     # Face detection with Amazon Rekognition Video is an asynchronous
-    # operation. You start face detection by calling which returns a job
-    # identifier (`JobId`). When the face detection operation finishes,
-    # Amazon Rekognition Video publishes a completion status to the Amazon
-    # Simple Notification Service topic registered in the initial call to
-    # `StartFaceDetection`. To get the results of the face detection
-    # operation, first check that the status value published to the Amazon
-    # SNS topic is `SUCCEEDED`. If so, call and pass the job identifier
-    # (`JobId`) from the initial call to `StartFaceDetection`.
+    # operation. You start face detection by calling StartFaceDetection
+    # which returns a job identifier (`JobId`). When the face detection
+    # operation finishes, Amazon Rekognition Video publishes a completion
+    # status to the Amazon Simple Notification Service topic registered in
+    # the initial call to `StartFaceDetection`. To get the results of the
+    # face detection operation, first check that the status value published
+    # to the Amazon SNS topic is `SUCCEEDED`. If so, call GetFaceDetection
+    # and pass the job identifier (`JobId`) from the initial call to
+    # `StartFaceDetection`.
     #
     # `GetFaceDetection` returns an array of detected faces (`Faces`) sorted
     # by the time the faces were detected.
@@ -1647,27 +1657,28 @@ module Aws::Rekognition
     end
 
     # Gets the face search results for Amazon Rekognition Video face search
-    # started by . The search returns faces in a collection that match the
-    # faces of persons detected in a video. It also includes the time(s)
-    # that faces are matched in the video.
+    # started by StartFaceSearch. The search returns faces in a collection
+    # that match the faces of persons detected in a video. It also includes
+    # the time(s) that faces are matched in the video.
     #
     # Face search in a video is an asynchronous operation. You start face
-    # search by calling to which returns a job identifier (`JobId`). When
-    # the search operation finishes, Amazon Rekognition Video publishes a
-    # completion status to the Amazon Simple Notification Service topic
-    # registered in the initial call to `StartFaceSearch`. To get the search
-    # results, first check that the status value published to the Amazon SNS
-    # topic is `SUCCEEDED`. If so, call `GetFaceSearch` and pass the job
-    # identifier (`JobId`) from the initial call to `StartFaceSearch`.
+    # search by calling to StartFaceSearch which returns a job identifier
+    # (`JobId`). When the search operation finishes, Amazon Rekognition
+    # Video publishes a completion status to the Amazon Simple Notification
+    # Service topic registered in the initial call to `StartFaceSearch`. To
+    # get the search results, first check that the status value published to
+    # the Amazon SNS topic is `SUCCEEDED`. If so, call `GetFaceSearch` and
+    # pass the job identifier (`JobId`) from the initial call to
+    # `StartFaceSearch`.
     #
     # For more information, see Searching Faces in a Collection in the
     # Amazon Rekognition Developer Guide.
     #
-    # The search results are retured in an array, `Persons`, of objects.
-    # Each`PersonMatch` element contains details about the matching faces in
-    # the input collection, person information (facial attributes, bounding
-    # boxes, and person identifer) for the matched person, and the time the
-    # person was matched in the video.
+    # The search results are retured in an array, `Persons`, of PersonMatch
+    # objects. Each`PersonMatch` element contains details about the matching
+    # faces in the input collection, person information (facial attributes,
+    # bounding boxes, and person identifer) for the matched person, and the
+    # time the person was matched in the video.
     #
     # <note markdown="1"> `GetFaceSearch` only returns the default facial attributes
     # (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
@@ -1791,16 +1802,17 @@ module Aws::Rekognition
     end
 
     # Gets the label detection results of a Amazon Rekognition Video
-    # analysis started by .
+    # analysis started by StartLabelDetection.
     #
-    # The label detection operation is started by a call to which returns a
-    # job identifier (`JobId`). When the label detection operation finishes,
-    # Amazon Rekognition publishes a completion status to the Amazon Simple
-    # Notification Service topic registered in the initial call to
-    # `StartlabelDetection`. To get the results of the label detection
-    # operation, first check that the status value published to the Amazon
-    # SNS topic is `SUCCEEDED`. If so, call and pass the job identifier
-    # (`JobId`) from the initial call to `StartLabelDetection`.
+    # The label detection operation is started by a call to
+    # StartLabelDetection which returns a job identifier (`JobId`). When the
+    # label detection operation finishes, Amazon Rekognition publishes a
+    # completion status to the Amazon Simple Notification Service topic
+    # registered in the initial call to `StartlabelDetection`. To get the
+    # results of the label detection operation, first check that the status
+    # value published to the Amazon SNS topic is `SUCCEEDED`. If so, call
+    # GetLabelDetection and pass the job identifier (`JobId`) from the
+    # initial call to `StartLabelDetection`.
     #
     # `GetLabelDetection` returns an array of detected labels (`Labels`)
     # sorted by the time the labels were detected. You can also sort by the
@@ -1810,6 +1822,10 @@ module Aws::Rekognition
     # in the accuracy of the detected label, and the time the label was
     # detected in the video.
     #
+    # The returned labels also include bounding box information for common
+    # objects, a hierarchical taxonomy of detected labels, and the version
+    # of the label model used for detection.
+    #
     # Use MaxResults parameter to limit the number of labels returned. If
     # there are more results than specified in `MaxResults`, the value of
     # `NextToken` in the operation response contains a pagination token for
@@ -1818,13 +1834,6 @@ module Aws::Rekognition
     # with the token value returned from the previous call to
     # `GetLabelDetection`.
     #
-    # <note markdown="1"> `GetLabelDetection` doesn't return a hierarchical taxonomy, or
-    # bounding box information, for detected labels. `GetLabelDetection`
-    # returns `null` for the `Parents` and `Instances` attributes of the
-    # object which is returned in the `Labels` array.
-    #
-    #  </note>
-    #
     # @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
@@ -1856,6 +1865,7 @@ module Aws::Rekognition
     #   * {Types::GetLabelDetectionResponse#video_metadata #video_metadata} => Types::VideoMetadata
     #   * {Types::GetLabelDetectionResponse#next_token #next_token} => String
     #   * {Types::GetLabelDetectionResponse#labels #labels} => Array&lt;Types::LabelDetection&gt;
+    #   * {Types::GetLabelDetectionResponse#label_model_version #label_model_version} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1889,6 +1899,7 @@ module Aws::Rekognition
     #   resp.labels[0].label.instances[0].confidence #=> Float
     #   resp.labels[0].label.parents #=> Array
     #   resp.labels[0].label.parents[0].name #=> String
+    #   resp.label_model_version #=> String
     #
     # @overload get_label_detection(params = {})
     # @param [Hash] params ({})
@@ -1898,7 +1909,7 @@ module Aws::Rekognition
     end
 
     # Gets the path tracking results of a Amazon Rekognition Video analysis
-    # started by .
+    # started by StartPersonTracking.
     #
     # The person path tracking operation is started by a call to
     # `StartPersonTracking` which returns a job identifier (`JobId`). When
@@ -1908,8 +1919,8 @@ module Aws::Rekognition
     #
     # To get the results of the person path tracking operation, first check
     # that the status value published to the Amazon SNS topic is
-    # `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
-    # the initial call to `StartPersonTracking`.
+    # `SUCCEEDED`. If so, call GetPersonTracking and pass the job identifier
+    # (`JobId`) from the initial call to `StartPersonTracking`.
     #
     # `GetPersonTracking` returns an array, `Persons`, of tracked persons
     # and the time(s) their paths were tracked in the video.
@@ -2045,12 +2056,13 @@ module Aws::Rekognition
     # the input image. For each face, the algorithm extracts facial features
     # into a feature vector, and stores it in the backend database. Amazon
     # Rekognition uses feature vectors when it performs face match and
-    # search operations using the and operations.
+    # search operations using the SearchFaces and SearchFacesByImage
+    # operations.
     #
     # For more information, see Adding Faces to a Collection in the Amazon
     # Rekognition Developer Guide.
     #
-    # To get the number of faces in a collection, call .
+    # To get the number of faces in a collection, call DescribeCollection.
     #
     # If you're using version 1.0 of the face detection model, `IndexFaces`
     # indexes the 15 largest faces in the input image. Later versions of the
@@ -2060,17 +2072,18 @@ module Aws::Rekognition
     # orientation information is not returned in the `OrientationCorrection`
     # field.
     #
-    # To determine which version of the model you're using, call and supply
-    # the collection ID. You can also get the model version from the value
-    # of `FaceModelVersion` in the response from `IndexFaces`
+    # To determine which version of the model you're using, call
+    # DescribeCollection and supply the collection ID. You can also get the
+    # model version from the value of `FaceModelVersion` in the response
+    # from `IndexFaces`
     #
     # For more information, see Model Versioning in the Amazon Rekognition
     # Developer Guide.
     #
     # If you provide the optional `ExternalImageID` for the input image you
     # provided, Amazon Rekognition associates this ID with all faces that it
-    # detects. When you call the operation, the response returns the
-    # external ID. You can use this external image ID to create a
+    # detects. When you call the ListFaces operation, the response returns
+    # the external ID. You can use this external image ID to create a
     # client-side index to associate the faces with each image. You can then
     # use the index to find all faces in an image.
     #
@@ -2089,13 +2102,13 @@ module Aws::Rekognition
     #
     # <note markdown="1"> To use quality filtering, you need a collection associated with
     # version 3 of the face model. To get the version of the face model
-    # associated with a collection, call .
+    # associated with a collection, call DescribeCollection.
     #
     #  </note>
     #
     # Information about faces detected in an image, but not indexed, is
-    # returned in an array of objects, `UnindexedFaces`. Faces aren't
-    # indexed for reasons such as:
+    # returned in an array of UnindexedFace objects, `UnindexedFaces`. Faces
+    # aren't indexed for reasons such as:
     #
     # * The number of faces detected exceeds the value of the `MaxFaces`
     #   request parameter.
@@ -2709,7 +2722,8 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
-    # Gets a list of stream processors that you have created with .
+    # Gets a list of stream processors that you have created with
+    # CreateStreamProcessor.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there are more stream
@@ -2768,7 +2782,8 @@ module Aws::Rekognition
     # information and use the `Celebrity` ID property as a unique identifier
     # for the celebrity. If you don't store the celebrity name or
     # additional information URLs returned by `RecognizeCelebrities`, you
-    # will need the ID to identify the celebrity in a call to the operation.
+    # will need the ID to identify the celebrity in a call to the
+    # GetCelebrityInfo operation.
     #
     # 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 AWS CLI
@@ -2994,8 +3009,8 @@ module Aws::Rekognition
     # specified collection.
     #
     # <note markdown="1"> To search for all faces in an input image, you might first call the
-    # operation, and then use the face IDs returned in subsequent calls to
-    # the operation.
+    # IndexFaces operation, and then use the face IDs returned in subsequent
+    # calls to the SearchFaces operation.
     #
     #  You can also call the `DetectFaces` operation and use the bounding
     # boxes in the response to make face crops, which then you can pass in
@@ -3144,8 +3159,9 @@ module Aws::Rekognition
     # Notification Service topic that you specify in `NotificationChannel`.
     # To get the results of the celebrity recognition analysis, first check
     # that the status value published to the Amazon SNS topic is
-    # `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
-    # the initial call to `StartCelebrityRecognition`.
+    # `SUCCEEDED`. If so, call GetCelebrityRecognition and pass the job
+    # identifier (`JobId`) from the initial call to
+    # `StartCelebrityRecognition`.
     #
     # For more information, see Recognizing Celebrities in the Amazon
     # Rekognition Developer Guide.
@@ -3215,8 +3231,9 @@ module Aws::Rekognition
     #
     # To get the results of the content moderation analysis, first check
     # that the status value published to the Amazon SNS topic is
-    # `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
-    # the initial call to `StartContentModeration`.
+    # `SUCCEEDED`. If so, call GetContentModeration and pass the job
+    # identifier (`JobId`) from the initial call to
+    # `StartContentModeration`.
     #
     # For more information, see Detecting Unsafe Content in the Amazon
     # Rekognition Developer Guide.
@@ -3293,8 +3310,9 @@ module Aws::Rekognition
     # status to the Amazon Simple Notification Service topic that you
     # specify in `NotificationChannel`. To get the results of the face
     # detection operation, first check that the status value published to
-    # the Amazon SNS topic is `SUCCEEDED`. If so, call and pass the job
-    # identifier (`JobId`) from the initial call to `StartFaceDetection`.
+    # the Amazon SNS topic is `SUCCEEDED`. If so, call GetFaceDetection and
+    # pass the job identifier (`JobId`) from the initial call to
+    # `StartFaceDetection`.
     #
     # For more information, see Detecting Faces in a Stored Video in the
     # Amazon Rekognition Developer Guide.
@@ -3371,8 +3389,8 @@ module Aws::Rekognition
     # Simple Notification Service topic that you specify in
     # `NotificationChannel`. To get the search results, first check that the
     # status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
-    # call and pass the job identifier (`JobId`) from the initial call to
-    # `StartFaceSearch`. For more information, see
+    # call GetFaceSearch and pass the job identifier (`JobId`) from the
+    # initial call to `StartFaceSearch`. For more information, see
     # procedure-person-search-videos.
     #
     # @option params [required, Types::Video] :video
@@ -3453,8 +3471,8 @@ module Aws::Rekognition
     #
     # To get the results of the label detection operation, first check that
     # the status value published to the Amazon SNS topic is `SUCCEEDED`. If
-    # so, call and pass the job identifier (`JobId`) from the initial call
-    # to `StartLabelDetection`.
+    # so, call GetLabelDetection and pass the job identifier (`JobId`) from
+    # the initial call to `StartLabelDetection`.
     #
     # @option params [required, Types::Video] :video
     #   The video in which you want to detect labels. The video must be stored
@@ -3532,8 +3550,8 @@ module Aws::Rekognition
     #
     # To get the results of the person detection operation, first check that
     # the status value published to the Amazon SNS topic is `SUCCEEDED`. If
-    # so, call and pass the job identifier (`JobId`) from the initial call
-    # to `StartPersonTracking`.
+    # so, call GetPersonTracking and pass the job identifier (`JobId`) from
+    # the initial call to `StartPersonTracking`.
     #
     # @option params [required, Types::Video] :video
     #   The video in which you want to detect people. The video must be stored
@@ -3587,9 +3605,9 @@ module Aws::Rekognition
     end
 
     # Starts processing a stream processor. You create a stream processor by
-    # calling . To tell `StartStreamProcessor` which stream processor to
-    # start, use the value of the `Name` field specified in the call to
-    # `CreateStreamProcessor`.
+    # calling CreateStreamProcessor. To tell `StartStreamProcessor` which
+    # stream processor to start, use the value of the `Name` field specified
+    # in the call to `CreateStreamProcessor`.
     #
     # @option params [required, String] :name
     #   The name of the stream processor to start processing.
@@ -3609,10 +3627,11 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
-    # Stops a running stream processor that was created by .
+    # Stops a running stream processor that was created by
+    # CreateStreamProcessor.
     #
     # @option params [required, String] :name
-    #   The name of a stream processor created by .
+    #   The name of a stream processor created by CreateStreamProcessor.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -3642,7 +3661,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.17.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -389,6 +389,7 @@ module Aws::Rekognition
     DetectModerationLabelsRequest.struct_class = Types::DetectModerationLabelsRequest
 
     DetectModerationLabelsResponse.add_member(:moderation_labels, Shapes::ShapeRef.new(shape: ModerationLabels, location_name: "ModerationLabels"))
+    DetectModerationLabelsResponse.add_member(:moderation_model_version, Shapes::ShapeRef.new(shape: String, location_name: "ModerationModelVersion"))
     DetectModerationLabelsResponse.struct_class = Types::DetectModerationLabelsResponse
 
     DetectTextRequest.add_member(:image, Shapes::ShapeRef.new(shape: Image, required: true, location_name: "Image"))
@@ -542,6 +543,7 @@ module Aws::Rekognition
     GetLabelDetectionResponse.add_member(:video_metadata, Shapes::ShapeRef.new(shape: VideoMetadata, location_name: "VideoMetadata"))
     GetLabelDetectionResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
     GetLabelDetectionResponse.add_member(:labels, Shapes::ShapeRef.new(shape: LabelDetections, location_name: "Labels"))
+    GetLabelDetectionResponse.add_member(:label_model_version, Shapes::ShapeRef.new(shape: String, location_name: "LabelModelVersion"))
     GetLabelDetectionResponse.struct_class = Types::GetLabelDetectionResponse
 
     GetPersonTrackingRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))

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

@@ -97,7 +97,8 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Provides information about a celebrity recognized by the operation.
+    # Provides information about a celebrity recognized by the
+    # RecognizeCelebrities operation.
     #
     # @!attribute [rw] urls
     #   An array of URLs pointing to additional information about the
@@ -462,7 +463,8 @@ module Aws::Rekognition
     # @!attribute [rw] name
     #   An identifier you assign to the stream processor. You can use `Name`
     #   to manage the stream processor. For example, you can get the current
-    #   status of the stream processor by calling . `Name` is idempotent.
+    #   status of the stream processor by calling DescribeStreamProcessor.
+    #   `Name` is idempotent.
     #   @return [String]
     #
     # @!attribute [rw] settings
@@ -585,7 +587,7 @@ module Aws::Rekognition
 
     # @!attribute [rw] face_count
     #   The number of faces that are indexed into the collection. To index
-    #   faces into a collection, use .
+    #   faces into a collection, use IndexFaces.
     #   @return [Integer]
     #
     # @!attribute [rw] face_model_version
@@ -791,7 +793,7 @@ module Aws::Rekognition
     #   than this specified value.
     #
     #   If `MinConfidence` is not specified, the operation returns labels
-    #   with a confidence values greater than or equal to 50 percent.
+    #   with a confidence values greater than or equal to 55 percent.
     #   @return [Float]
     #
     class DetectLabelsRequest < Struct.new(
@@ -875,8 +877,14 @@ module Aws::Rekognition
     #   from the start of the video, they were detected.
     #   @return [Array<Types::ModerationLabel>]
     #
+    # @!attribute [rw] moderation_model_version
+    #   Version number of the moderation detection model that was used to
+    #   detect unsafe content.
+    #   @return [String]
+    #
     class DetectModerationLabelsResponse < Struct.new(
-      :moderation_labels)
+      :moderation_labels,
+      :moderation_model_version)
       include Aws::Structure
     end
 
@@ -1007,12 +1015,12 @@ module Aws::Rekognition
     # all facial attributes. The default attributes are `BoundingBox`,
     # `Confidence`, `Landmarks`, `Pose`, and `Quality`.
     #
-    # is the only Amazon Rekognition Video stored video operation that can
-    # return a `FaceDetail` object with all attributes. To specify which
-    # attributes to return, use the `FaceAttributes` input parameter for .
-    # The following Amazon Rekognition Video operations return only the
-    # default attributes. The corresponding Start operations don't have a
-    # `FaceAttributes` input parameter.
+    # GetFaceDetection is the only Amazon Rekognition Video stored video
+    # operation that can return a `FaceDetail` object with all attributes.
+    # To specify which attributes to return, use the `FaceAttributes` input
+    # parameter for StartFaceDetection. The following Amazon Rekognition
+    # Video operations return only the default attributes. The corresponding
+    # Start operations don't have a `FaceAttributes` input parameter.
     #
     # * GetCelebrityRecognition
     #
@@ -1020,10 +1028,10 @@ module Aws::Rekognition
     #
     # * GetFaceSearch
     #
-    # The Amazon Rekognition Image and operations can return all facial
-    # attributes. To specify which attributes to return, use the
-    # `Attributes` input parameter for `DetectFaces`. For `IndexFaces`, use
-    # the `DetectAttributes` input parameter.
+    # The Amazon Rekognition Image DetectFaces and IndexFaces operations can
+    # return all facial attributes. To specify which attributes to return,
+    # use the `Attributes` input parameter for `DetectFaces`. For
+    # `IndexFaces`, use the `DetectAttributes` input parameter.
     #
     # @!attribute [rw] bounding_box
     #   Bounding box of the face. Default attribute.
@@ -1174,7 +1182,8 @@ module Aws::Rekognition
     end
 
     # Input face recognition parameters for an Amazon Rekognition stream
-    # processor. `FaceRecognitionSettings` is a request parameter for .
+    # processor. `FaceRecognitionSettings` is a request parameter for
+    # CreateStreamProcessor.
     #
     # @note When making an API call, you may pass FaceSearchSettings
     #   data as a hash:
@@ -1217,7 +1226,8 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Information about where the text detected by is located on an image.
+    # Information about where the text detected by DetectText is located on
+    # an image.
     #
     # @!attribute [rw] bounding_box
     #   An axis-aligned coarse representation of the detected text's
@@ -1244,7 +1254,8 @@ module Aws::Rekognition
     #
     # @!attribute [rw] id
     #   The ID for the celebrity. You get the celebrity ID from a call to
-    #   the operation, which recognizes celebrities in an image.
+    #   the RecognizeCelebrities operation, which recognizes celebrities in
+    #   an image.
     #   @return [String]
     #
     class GetCelebrityInfoRequest < Struct.new(
@@ -1559,13 +1570,14 @@ module Aws::Rekognition
     #   @return [Types::VideoMetadata]
     #
     # @!attribute [rw] persons
-    #   An array of persons, , in the video whose face(s) match the face(s)
-    #   in an Amazon Rekognition collection. It also includes time
-    #   information for when persons are matched in the video. You specify
-    #   the input collection in an initial call to `StartFaceSearch`. Each
-    #   `Persons` element includes a time the person was matched, face match
-    #   details (`FaceMatches`) for matching faces in the collection, and
-    #   person information (`Person`) for the matched person.
+    #   An array of persons, PersonMatch, in the video whose face(s) match
+    #   the face(s) in an Amazon Rekognition collection. It also includes
+    #   time information for when persons are matched in the video. You
+    #   specify the input collection in an initial call to
+    #   `StartFaceSearch`. Each `Persons` element includes a time the person
+    #   was matched, face match details (`FaceMatches`) for matching faces
+    #   in the collection, and person information (`Person`) for the matched
+    #   person.
     #   @return [Array<Types::PersonMatch>]
     #
     class GetFaceSearchResponse < Struct.new(
@@ -1650,12 +1662,18 @@ module Aws::Rekognition
     #   video, that the label was detected.
     #   @return [Array<Types::LabelDetection>]
     #
+    # @!attribute [rw] label_model_version
+    #   Version number of the label detection model that was used to detect
+    #   labels.
+    #   @return [String]
+    #
     class GetLabelDetectionResponse < Struct.new(
       :job_status,
       :status_message,
       :video_metadata,
       :next_token,
-      :labels)
+      :labels,
+      :label_model_version)
       include Aws::Structure
     end
 
@@ -1940,7 +1958,8 @@ module Aws::Rekognition
     #     object locations before the image is rotated.
     #
     #   Bounding box information is returned in the `FaceRecords` array. You
-    #   can get the version of the face detection model by calling .
+    #   can get the version of the face detection model by calling
+    #   DescribeCollection.
     #   @return [String]
     #
     # @!attribute [rw] face_model_version
@@ -1964,15 +1983,16 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # An instance of a label detected by .
+    # An instance of a label returned by Amazon Rekognition Image
+    # (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).
     #
     # @!attribute [rw] bounding_box
     #   The position of the label instance on the image.
     #   @return [Types::BoundingBox]
     #
     # @!attribute [rw] confidence
-    #   The confidence that Amazon Rekognition Image has in the accuracy of
-    #   the bounding box.
+    #   The confidence that Amazon Rekognition has in the accuracy of the
+    #   bounding box.
     #   @return [Float]
     #
     class Instance < Struct.new(
@@ -2024,13 +2044,7 @@ module Aws::Rekognition
     end
 
     # Structure containing details about the detected label, including the
-    # name, and level of confidence.
-    #
-    # The Amazon Rekognition Image operation operation returns a
-    # hierarchical taxonomy (`Parents`) for detected labels and also
-    # bounding box information (`Instances`) for detected labels. Amazon
-    # Rekognition Video doesn't return this information and returns `null`
-    # for the `Parents` and `Instances` attributes.
+    # name, detected instances, parent labels, and level of confidence.
     #
     # @!attribute [rw] name
     #   The name (label) of the object or scene.
@@ -2045,23 +2059,11 @@ module Aws::Rekognition
     #   boxes for each instance of the detected object. Bounding boxes are
     #   returned for common object labels such as people, cars, furniture,
     #   apparel or pets.
-    #
-    #   <note markdown="1"> Amazon Rekognition Video does not support bounding box information
-    #   for detected labels. The value of `Instances` is returned as `null`
-    #   by `GetLabelDetection`.
-    #
-    #    </note>
     #   @return [Array<Types::Instance>]
     #
     # @!attribute [rw] parents
     #   The parent labels for a label. The response includes all ancestor
     #   labels.
-    #
-    #   <note markdown="1"> Amazon Rekognition Video does not support a hierarchical taxonomy of
-    #   detected labels. The value of `Parents` is returned as `null` by
-    #   `GetLabelDetection`.
-    #
-    #    </note>
     #   @return [Array<Types::Parent>]
     #
     class Label < Struct.new(
@@ -2390,8 +2392,8 @@ module Aws::Rekognition
     # people's paths return an array of `PersonDetection` objects with
     # elements for each time a person's path is tracked in a video.
     #
-    # For more information, see API\_GetPersonTracking in the Amazon
-    # Rekognition Developer Guide.
+    # For more information, see GetPersonTracking in the Amazon Rekognition
+    # Developer Guide.
     #
     # @!attribute [rw] timestamp
     #   The time, in milliseconds from the start of the video, that the
@@ -2410,9 +2412,10 @@ module Aws::Rekognition
 
     # Information about a person whose face matches a face(s) in an Amazon
     # Rekognition collection. Includes information about the faces in the
-    # Amazon Rekognition collection (), information about the person
-    # (PersonDetail), and the time stamp for when the person was detected in
-    # a video. An array of `PersonMatch` objects is returned by .
+    # Amazon Rekognition collection (FaceMatch), information about the
+    # person (PersonDetail), and the time stamp for when the person was
+    # detected in a video. An array of `PersonMatch` objects is returned by
+    # GetFaceSearch.
     #
     # @!attribute [rw] timestamp
     #   The time, in milliseconds from the beginning of the video, that the
@@ -2440,9 +2443,10 @@ module Aws::Rekognition
     # input image is 700x200 and the operation returns X=0.5 and Y=0.25,
     # then the point is at the (350,50) pixel coordinate on the image.
     #
-    # An array of `Point` objects, `Polygon`, is returned by . `Polygon`
-    # represents a fine-grained polygon around detected text. For more
-    # information, see Geometry in the Amazon Rekognition Developer Guide.
+    # An array of `Point` objects, `Polygon`, is returned by DetectText.
+    # `Polygon` represents a fine-grained polygon around detected text. For
+    # more information, see Geometry in the Amazon Rekognition Developer
+    # Guide.
     #
     # @!attribute [rw] x
     #   The value of the X coordinate for a point on a `Polygon`.
@@ -3162,7 +3166,7 @@ module Aws::Rekognition
     #       }
     #
     # @!attribute [rw] name
-    #   The name of a stream processor created by .
+    #   The name of a stream processor created by CreateStreamProcessor.
     #   @return [String]
     #
     class StopStreamProcessorRequest < Struct.new(
@@ -3173,10 +3177,11 @@ module Aws::Rekognition
     class StopStreamProcessorResponse < Aws::EmptyStructure; end
 
     # An object that recognizes faces in a streaming video. An Amazon
-    # Rekognition stream processor is created by a call to . The request
-    # parameters for `CreateStreamProcessor` describe the Kinesis video
-    # stream source for the streaming video, face recognition parameters,
-    # and where to stream the analysis resullts.
+    # Rekognition stream processor is created by a call to
+    # CreateStreamProcessor. The request parameters for
+    # `CreateStreamProcessor` describe the Kinesis video stream source for
+    # the streaming video, face recognition parameters, and where to stream
+    # the analysis resullts.
     #
     # @!attribute [rw] name
     #   Name of the Amazon Rekognition stream processor.
@@ -3277,7 +3282,7 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # Information about a word or line of text detected by .
+    # Information about a word or line of text detected by DetectText.
     #
     # The `DetectedText` field contains the text that Amazon Rekognition
     # detected in the image.
@@ -3331,8 +3336,8 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
-    # A face that detected, but didn't index. Use the `Reasons` response
-    # attribute to determine why a face wasn't indexed.
+    # A face that IndexFaces detected, but didn't index. Use the `Reasons`
+    # response attribute to determine why a face wasn't indexed.
     #
     # @!attribute [rw] reasons
     #   An array of reasons that specify why a face wasn't indexed.
@@ -3366,8 +3371,9 @@ module Aws::Rekognition
     end
 
     # Video file stored in an Amazon S3 bucket. Amazon Rekognition video
-    # start operations such as use `Video` to specify a video for analysis.
-    # The supported file formats are .mp4, .mov and .avi.
+    # start operations such as StartLabelDetection use `Video` to specify a
+    # video for analysis. The supported file formats are .mp4, .mov and
+    # .avi.
     #
     # @note When making an API call, you may pass Video
     #   data as a hash:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core