aws-sdk-rekognition 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e16847728f1adb8be09b3151d0a620331732c47
-  data.tar.gz: bb0e05b6d4bd8b62fb4cc77db6c024a10463b811
+  metadata.gz: 1ac8d435bb1b247165c67d9a2028fb961fcd9086
+  data.tar.gz: 57c60fa8d273ec92bcdf8fbed114c78e7cf8d352
 SHA512:
-  metadata.gz: eef30fdd8159d4bb67ec25c5bbe63e88e1bdb14dd5acfcabd9512613017cff75b52912868a3ba5e6e68c3ad592f5a322c3b5c32523bdc671a47a542f2eb9287e
-  data.tar.gz: cb2ca91dd467ae9f4560deba526e01ba4ca547cc8bc87966208689841db4ed75266501932e1746b88a3c61ef84ca65bc9ce9c5bf32381c39fee97f33e572bd7a
+  metadata.gz: 0a34bc891ef85c474dd7d282260cbfb91f773ab00ba7624a2be85e4c524ef117a6c1b4993b61c5caaa976f74eb49c339589e36e16586272302e74bd72cf41114
+  data.tar.gz: 4ad1790e61ddf6f3f0f4f3ebaa0c11110042a3648639a5f36c8eeddb745e5fb4112efe194c5b326d461a06d48a3c92dab0d22431e1ec3465476fee4a91c973a6

data/lib/aws-sdk-rekognition.rb

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

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

@@ -1172,6 +1172,13 @@ module Aws::Rekognition
     # `CelebrityRecognition` contains information about the celebrity in a
     # 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
+    # other facial attributes listed in the `Face` object of the following
+    # response syntax are not returned. For more information, see .
+    #
+    #  </note>
+    #
     # By default, the `Celebrities` array is sorted by time (milliseconds
     # from the start of the video). You can also sort the array by celebrity
     # by specifying the value `ID` in the `SortBy` input parameter.
@@ -1196,8 +1203,10 @@ module Aws::Rekognition
     #   can get the job identifer from a call to `StartCelebrityRecognition`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of celebrities you want Rekognition Video to return in
-    #   the response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there is more
@@ -1330,7 +1339,9 @@ module Aws::Rekognition
     #   the job in a subsequent call to `GetContentModeration`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of content moderation labels to return. The default is
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
     #   1000.
     #
     # @option params [String] :next_token
@@ -1415,7 +1426,10 @@ module Aws::Rekognition
     #   from `StartFaceDetection`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of detected faces to return. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there are more faces
@@ -1512,8 +1526,16 @@ module Aws::Rekognition
     #
     # 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 for the matched person, and
-    # the time the person was matched in the video.
+    # 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
+    # other facial attributes listed in the `Face` object of the following
+    # response syntax are not returned. For more information, see .
+    #
+    #  </note>
     #
     # By default, the `Persons` array is sorted by the time, in milliseconds
     # from the start of the video, persons are matched. You can also sort by
@@ -1524,8 +1546,10 @@ module Aws::Rekognition
     #   from an initial call to `StartFaceSearch`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of search results you want Rekognition Video to return
-    #   in the response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there is more search
@@ -1660,8 +1684,10 @@ module Aws::Rekognition
     #   `StartlabelDetection`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of labels you want Amazon Rekognition to return in the
-    #   response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there are more labels
@@ -1733,6 +1759,13 @@ module Aws::Rekognition
     # `GetPersonTracking` returns an array, `Persons`, of tracked persons
     # and the time(s) they were tracked in the video.
     #
+    # <note markdown="1"> `GetPersonTracking` only returns the default facial attributes
+    # (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
+    # other facial attributes listed in the `Face` object of the following
+    # response syntax are not returned. For more information, see .
+    #
+    #  </note>
+    #
     # By default, the array is sorted by the time(s) a person is tracked in
     # the video. You can sort by tracked persons by specifying `INDEX` for
     # the `SortBy` input parameter.
@@ -1750,7 +1783,10 @@ module Aws::Rekognition
     #   `JobId` from a call to `StartPersonTracking`.
     #
     # @option params [Integer] :max_results
-    #   Maximum number of tracked persons to return. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there are more
@@ -3297,7 +3333,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -949,8 +949,30 @@ module Aws::Rekognition
     # Structure containing attributes of the face that the algorithm
     # detected.
     #
+    # A `FaceDetail` object contains either the default facial attributes or
+    # all facial attributes. The default attributes are `BoundingBox`,
+    # `Confidence`, `Landmarks`, `Pose`, and `Quality`.
+    #
+    # is the only 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 Rekognition Video operations return only the default
+    # attributes. The corresponding Start operations don't have a
+    # `FaceAttributes` input parameter.
+    #
+    # * GetCelebrityRecognition
+    #
+    # * GetPersonTracking
+    #
+    # * GetFaceSearch
+    #
+    # The 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.
+    #
     # @!attribute [rw] bounding_box
-    #   Bounding box of the face.
+    #   Bounding box of the face. Default attribute.
     #   @return [Types::BoundingBox]
     #
     # @!attribute [rw] age_range
@@ -1003,21 +1025,21 @@ module Aws::Rekognition
     #   @return [Array<Types::Emotion>]
     #
     # @!attribute [rw] landmarks
-    #   Indicates the location of landmarks on the face.
+    #   Indicates the location of landmarks on the face. Default attribute.
     #   @return [Array<Types::Landmark>]
     #
     # @!attribute [rw] pose
     #   Indicates the pose of the face as determined by its pitch, roll, and
-    #   yaw.
+    #   yaw. Default attribute.
     #   @return [Types::Pose]
     #
     # @!attribute [rw] quality
-    #   Identifies image brightness and sharpness.
+    #   Identifies image brightness and sharpness. Default attribute.
     #   @return [Types::ImageQuality]
     #
     # @!attribute [rw] confidence
     #   Confidence level that the bounding box contains a face (and not a
-    #   different object such as a tree).
+    #   different object such as a tree). Default attribute.
     #   @return [Float]
     #
     class FaceDetail < Struct.new(
@@ -1207,8 +1229,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of celebrities you want Rekognition Video to return
-    #   in the response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1282,8 +1306,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of content moderation labels to return. The default
-    #   is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1358,7 +1384,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of detected faces to return. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1427,8 +1456,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of search results you want Rekognition Video to
-    #   return in the response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1509,8 +1540,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of labels you want Amazon Rekognition to return in
-    #   the response. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -1588,7 +1621,10 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] max_results
-    #   Maximum number of tracked persons to return. The default is 1000.
+    #   Maximum number of results to return per paginated call. The largest
+    #   value you can specify is 1000. If you specify a value greater than
+    #   1000, a maximum of 1000 results is returned. The default value is
+    #   1000.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -2189,7 +2225,7 @@ module Aws::Rekognition
 
     # Information about a person whose face matches a face(s) in a Amazon
     # Rekognition collection. Includes information about the faces in the
-    # Amazon Rekognition collection (,information about the person
+    # Amazon Rekognition collection (, information about the person
     # (PersonDetail) and the timestamp for when the person was detected in a
     # video. An array of `PersonMatch` objects is returned by .
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Amazon Rekognition