aws-sdk-rekognition 1.77.0 → 1.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf5c7859181522a4322bb28b227f826708fea75bb9e6e6fd17a27cf253ebe4a
-  data.tar.gz: 5810b0c1f8db97a648758699fe24588a16ae36c84fb98f20ce5cc6a28f0e8325
+  metadata.gz: 92fdb88e568540ca97efe52954c59a0e67b3cfedcd162ef96f8d5983a4942ca0
+  data.tar.gz: a0372d1b1246e81cf6700ed793c2a7d65d9037a09982d419be0f4ee152610572
 SHA512:
-  metadata.gz: 21eb95aafca3a2e86e776c3236dab83c68711aba389eaa584cf71a49bd697f9944beb183a0bc634bb252e4e2ab316aaf98a6b996f3aa3c17b6a525f188821580
-  data.tar.gz: 4e80e911c1d258bf8d48dcd2c2f108c89aff9199d81b798cc9f6d942cc8a0845df06c37747247c7ff9da9bb0d8ff746047a3bc5db80b371c46f4f71ea2c15fb3
+  metadata.gz: 8c09938c4a35cabab9304c8ce6d86e6b48512531053bcc8c303a804202c33e5cbb7f3fa7fd5bb18ba24db19802034abaa0edca28d6d78e23f36cfdcfb9576ad3
+  data.tar.gz: dd3b85fa26ea01b6149f8e728d08addc2de2693c001af0576e91abc5d4a7919bac9633a24981e35f0915e92c56cf126793b95ad423be3c12235b367e4dea4dc8

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.78.0 (2023-05-04)
+------------------
+
+* Feature - This release adds a new attribute FaceOccluded. Additionally, you can now select attributes individually (e.g. ["DEFAULT", "FACE_OCCLUDED", "AGE_RANGE"] instead of ["ALL"]), which can reduce response time.
+
 1.77.0 (2023-04-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.77.0
+1.78.0

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

@@ -2056,8 +2056,8 @@ module Aws::Rekognition
     # face detected, the operation returns face details. These details
     # include a bounding box of the face, a confidence value (that the
     # bounding box contains a face), and a fixed set of attributes such as
-    # facial landmarks (for example, coordinates of eye and mouth), presence
-    # of beard, sunglasses, and so on.
+    # facial landmarks (for example, coordinates of eye and mouth), pose,
+    # presence of facial occlusion, and so on.
     #
     # The face-detection algorithm is most effective on frontal faces. For
     # non-frontal or obscured faces, the algorithm might not detect the
@@ -2087,17 +2087,17 @@ module Aws::Rekognition
     #   guide.
     #
     # @option params [Array<String>] :attributes
-    #   An array of facial attributes you want to be returned. This can be the
-    #   default list of attributes or all attributes. If you don't specify a
-    #   value for `Attributes` or if you specify `["DEFAULT"]`, the API
-    #   returns the following subset of facial attributes: `BoundingBox`,
-    #   `Confidence`, `Pose`, `Quality`, and `Landmarks`. If you provide
-    #   `["ALL"]`, all facial attributes are returned, but the operation takes
-    #   longer to complete.
+    #   An array of facial attributes you want to be returned. A `DEFAULT`
+    #   subset of facial attributes - `BoundingBox`, `Confidence`, `Pose`,
+    #   `Quality`, and `Landmarks` - will always be returned. You can request
+    #   for specific facial attributes (in addition to the default list) - by
+    #   using \[`"DEFAULT", "FACE_OCCLUDED"`\] or just \[`"FACE_OCCLUDED"`\].
+    #   You can request for all facial attributes by using \[`"ALL"]`.
+    #   Requesting more attributes may increase response time.
     #
     #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a logical
-    #   AND operator to determine which attributes to return (in this case,
-    #   all attributes).
+    #   "AND" operator to determine which attributes to return (in this
+    #   case, all attributes).
     #
     # @return [Types::DetectFacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2181,7 +2181,7 @@ module Aws::Rekognition
     #         version: "S3ObjectVersion",
     #       },
     #     },
-    #     attributes: ["DEFAULT"], # accepts DEFAULT, ALL
+    #     attributes: ["DEFAULT"], # accepts DEFAULT, ALL, AGE_RANGE, BEARD, EMOTIONS, EYEGLASSES, EYES_OPEN, GENDER, MOUTH_OPEN, MUSTACHE, FACE_OCCLUDED, SMILE, SUNGLASSES
     #   })
     #
     # @example Response structure
@@ -2222,6 +2222,8 @@ module Aws::Rekognition
     #   resp.face_details[0].quality.brightness #=> Float
     #   resp.face_details[0].quality.sharpness #=> Float
     #   resp.face_details[0].confidence #=> Float
+    #   resp.face_details[0].face_occluded.value #=> Boolean
+    #   resp.face_details[0].face_occluded.confidence #=> Float
     #   resp.orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #
     # @overload detect_faces(params = {})
@@ -3077,6 +3079,8 @@ module Aws::Rekognition
     #   resp.celebrities[0].celebrity.face.quality.brightness #=> Float
     #   resp.celebrities[0].celebrity.face.quality.sharpness #=> Float
     #   resp.celebrities[0].celebrity.face.confidence #=> Float
+    #   resp.celebrities[0].celebrity.face.face_occluded.value #=> Boolean
+    #   resp.celebrities[0].celebrity.face.face_occluded.confidence #=> Float
     #   resp.celebrities[0].celebrity.known_gender.type #=> String, one of "Male", "Female", "Nonbinary", "Unlisted"
     #   resp.job_id #=> String
     #   resp.video.s3_object.bucket #=> String
@@ -3335,6 +3339,8 @@ module Aws::Rekognition
     #   resp.faces[0].face.quality.brightness #=> Float
     #   resp.faces[0].face.quality.sharpness #=> Float
     #   resp.faces[0].face.confidence #=> Float
+    #   resp.faces[0].face.face_occluded.value #=> Boolean
+    #   resp.faces[0].face.face_occluded.confidence #=> Float
     #   resp.job_id #=> String
     #   resp.video.s3_object.bucket #=> String
     #   resp.video.s3_object.name #=> String
@@ -3538,6 +3544,8 @@ module Aws::Rekognition
     #   resp.persons[0].person.face.quality.brightness #=> Float
     #   resp.persons[0].person.face.quality.sharpness #=> Float
     #   resp.persons[0].person.face.confidence #=> Float
+    #   resp.persons[0].person.face.face_occluded.value #=> Boolean
+    #   resp.persons[0].person.face.face_occluded.confidence #=> Float
     #   resp.persons[0].face_matches #=> Array
     #   resp.persons[0].face_matches[0].similarity #=> Float
     #   resp.persons[0].face_matches[0].face.face_id #=> String
@@ -3885,6 +3893,8 @@ module Aws::Rekognition
     #   resp.persons[0].person.face.quality.brightness #=> Float
     #   resp.persons[0].person.face.quality.sharpness #=> Float
     #   resp.persons[0].person.face.confidence #=> Float
+    #   resp.persons[0].person.face.face_occluded.value #=> Boolean
+    #   resp.persons[0].person.face.face_occluded.confidence #=> Float
     #   resp.job_id #=> String
     #   resp.video.s3_object.bucket #=> String
     #   resp.video.s3_object.name #=> String
@@ -4216,13 +4226,15 @@ module Aws::Rekognition
     #
     # * An image ID, `ImageId`, assigned by the service for the input image.
     #
-    # If you request all facial attributes (by using the
-    # `detectionAttributes` parameter), Amazon Rekognition returns detailed
-    # facial attributes, such as facial landmarks (for example, location of
-    # eye and mouth) and other facial attributes. If you provide the same
-    # image, specify the same collection, and use the same external ID in
-    # the `IndexFaces` operation, Amazon Rekognition doesn't save duplicate
-    # face metadata.
+    # If you request `ALL` or specific facial attributes (e.g.,
+    # `FACE_OCCLUDED`) by using the detectionAttributes parameter, Amazon
+    # Rekognition returns detailed facial attributes, such as facial
+    # landmarks (for example, location of eye and mouth), facial occlusion,
+    # and other facial attributes.
+    #
+    # If you provide the same image, specify the same collection, and use
+    # the same external ID in the `IndexFaces` operation, Amazon Rekognition
+    # doesn't save duplicate face metadata.
     #
     #
     #
@@ -4252,13 +4264,13 @@ module Aws::Rekognition
     #   The ID you want to assign to all the faces detected in the image.
     #
     # @option params [Array<String>] :detection_attributes
-    #   An array of facial attributes that you want to be returned. This can
-    #   be the default list of attributes or all attributes. If you don't
-    #   specify a value for `Attributes` or if you specify `["DEFAULT"]`, the
-    #   API returns the following subset of facial attributes: `BoundingBox`,
-    #   `Confidence`, `Pose`, `Quality`, and `Landmarks`. If you provide
-    #   `["ALL"]`, all facial attributes are returned, but the operation takes
-    #   longer to complete.
+    #   An array of facial attributes you want to be returned. A `DEFAULT`
+    #   subset of facial attributes - `BoundingBox`, `Confidence`, `Pose`,
+    #   `Quality`, and `Landmarks` - will always be returned. You can request
+    #   for specific facial attributes (in addition to the default list) - by
+    #   using `["DEFAULT", "FACE_OCCLUDED"]` or just `["FACE_OCCLUDED"]`. You
+    #   can request for all facial attributes by using `["ALL"]`. Requesting
+    #   more attributes may increase response time.
     #
     #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a logical
     #   AND operator to determine which attributes to return (in this case,
@@ -4459,7 +4471,7 @@ module Aws::Rekognition
     #       },
     #     },
     #     external_image_id: "ExternalImageId",
-    #     detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL
+    #     detection_attributes: ["DEFAULT"], # accepts DEFAULT, ALL, AGE_RANGE, BEARD, EMOTIONS, EYEGLASSES, EYES_OPEN, GENDER, MOUTH_OPEN, MUSTACHE, FACE_OCCLUDED, SMILE, SUNGLASSES
     #     max_faces: 1,
     #     quality_filter: "NONE", # accepts NONE, AUTO, LOW, MEDIUM, HIGH
     #   })
@@ -4511,6 +4523,8 @@ module Aws::Rekognition
     #   resp.face_records[0].face_detail.quality.brightness #=> Float
     #   resp.face_records[0].face_detail.quality.sharpness #=> Float
     #   resp.face_records[0].face_detail.confidence #=> Float
+    #   resp.face_records[0].face_detail.face_occluded.value #=> Boolean
+    #   resp.face_records[0].face_detail.face_occluded.confidence #=> Float
     #   resp.orientation_correction #=> String, one of "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270"
     #   resp.face_model_version #=> String
     #   resp.unindexed_faces #=> Array
@@ -4551,6 +4565,8 @@ module Aws::Rekognition
     #   resp.unindexed_faces[0].face_detail.quality.brightness #=> Float
     #   resp.unindexed_faces[0].face_detail.quality.sharpness #=> Float
     #   resp.unindexed_faces[0].face_detail.confidence #=> Float
+    #   resp.unindexed_faces[0].face_detail.face_occluded.value #=> Boolean
+    #   resp.unindexed_faces[0].face_detail.face_occluded.confidence #=> Float
     #
     # @overload index_faces(params = {})
     # @param [Hash] params ({})
@@ -6766,7 +6782,7 @@ module Aws::Rekognition
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.77.0'
+      context[:gem_version] = '1.78.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -171,6 +171,7 @@ module Aws::Rekognition
     FaceMatch = Shapes::StructureShape.new(name: 'FaceMatch')
     FaceMatchList = Shapes::ListShape.new(name: 'FaceMatchList')
     FaceModelVersionList = Shapes::ListShape.new(name: 'FaceModelVersionList')
+    FaceOccluded = Shapes::StructureShape.new(name: 'FaceOccluded')
     FaceRecord = Shapes::StructureShape.new(name: 'FaceRecord')
     FaceRecordList = Shapes::ListShape.new(name: 'FaceRecordList')
     FaceSearchSettings = Shapes::StructureShape.new(name: 'FaceSearchSettings')
@@ -987,6 +988,7 @@ module Aws::Rekognition
     FaceDetail.add_member(:pose, Shapes::ShapeRef.new(shape: Pose, location_name: "Pose"))
     FaceDetail.add_member(:quality, Shapes::ShapeRef.new(shape: ImageQuality, location_name: "Quality"))
     FaceDetail.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    FaceDetail.add_member(:face_occluded, Shapes::ShapeRef.new(shape: FaceOccluded, location_name: "FaceOccluded"))
     FaceDetail.struct_class = Types::FaceDetail
 
     FaceDetailList.member = Shapes::ShapeRef.new(shape: FaceDetail)
@@ -1009,6 +1011,10 @@ module Aws::Rekognition
 
     FaceModelVersionList.member = Shapes::ShapeRef.new(shape: String)
 
+    FaceOccluded.add_member(:value, Shapes::ShapeRef.new(shape: Boolean, location_name: "Value"))
+    FaceOccluded.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
+    FaceOccluded.struct_class = Types::FaceOccluded
+
     FaceRecord.add_member(:face, Shapes::ShapeRef.new(shape: Face, location_name: "Face"))
     FaceRecord.add_member(:face_detail, Shapes::ShapeRef.new(shape: FaceDetail, location_name: "FaceDetail"))
     FaceRecord.struct_class = Types::FaceRecord

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

@@ -851,7 +851,8 @@ module Aws::Rekognition
     #   audit images will be stored. Note that the Amazon S3 bucket must be
     #   located in the caller's AWS account and in the same region as the
     #   Face Liveness end-point. Additionally, the Amazon S3 object keys are
-    #   auto-generated by the Face Liveness system.
+    #   auto-generated by the Face Liveness system. Requires that the caller
+    #   has the `s3:PutObject` permission on the Amazon S3 bucket.
     #   @return [Types::LivenessOutputConfig]
     #
     # @!attribute [rw] audit_images_limit
@@ -1819,16 +1820,17 @@ module Aws::Rekognition
     #   @return [Types::Image]
     #
     # @!attribute [rw] attributes
-    #   An array of facial attributes you want to be returned. This can be
-    #   the default list of attributes or all attributes. If you don't
-    #   specify a value for `Attributes` or if you specify `["DEFAULT"]`,
-    #   the API returns the following subset of facial attributes:
-    #   `BoundingBox`, `Confidence`, `Pose`, `Quality`, and `Landmarks`. If
-    #   you provide `["ALL"]`, all facial attributes are returned, but the
-    #   operation takes longer to complete.
+    #   An array of facial attributes you want to be returned. A `DEFAULT`
+    #   subset of facial attributes - `BoundingBox`, `Confidence`, `Pose`,
+    #   `Quality`, and `Landmarks` - will always be returned. You can
+    #   request for specific facial attributes (in addition to the default
+    #   list) - by using \[`"DEFAULT", "FACE_OCCLUDED"`\] or just
+    #   \[`"FACE_OCCLUDED"`\]. You can request for all facial attributes by
+    #   using \[`"ALL"]`. Requesting more attributes may increase response
+    #   time.
     #
     #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a
-    #   logical AND operator to determine which attributes to return (in
+    #   logical "AND" operator to determine which attributes to return (in
     #   this case, all attributes).
     #   @return [Array<String>]
     #
@@ -2608,6 +2610,16 @@ module Aws::Rekognition
     #   different object such as a tree). Default attribute.
     #   @return [Float]
     #
+    # @!attribute [rw] face_occluded
+    #   `FaceOccluded` should return "true" with a high confidence score
+    #   if a detected face’s eyes, nose, and mouth are partially captured or
+    #   if they are covered by masks, dark sunglasses, cell phones, hands,
+    #   or other objects. `FaceOccluded` should return "false" with a high
+    #   confidence score if common occurrences that do not impact face
+    #   verification are detected, such as eye glasses, lightly tinted
+    #   sunglasses, strands of hair, and others.
+    #   @return [Types::FaceOccluded]
+    #
     class FaceDetail < Struct.new(
       :bounding_box,
       :age_range,
@@ -2623,7 +2635,8 @@ module Aws::Rekognition
       :landmarks,
       :pose,
       :quality,
-      :confidence)
+      :confidence,
+      :face_occluded)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2668,6 +2681,37 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # `FaceOccluded` should return "true" with a high confidence score if
+    # a detected face’s eyes, nose, and mouth are partially captured or if
+    # they are covered by masks, dark sunglasses, cell phones, hands, or
+    # other objects. `FaceOccluded` should return "false" with a high
+    # confidence score if common occurrences that do not impact face
+    # verification are detected, such as eye glasses, lightly tinted
+    # sunglasses, strands of hair, and others.
+    #
+    # You can use `FaceOccluded` to determine if an obstruction on a face
+    # negatively impacts using the image for face matching.
+    #
+    # @!attribute [rw] value
+    #   True if a detected face’s eyes, nose, and mouth are partially
+    #   captured or if they are covered by masks, dark sunglasses, cell
+    #   phones, hands, or other objects. False if common occurrences that do
+    #   not impact face verification are detected, such as eye glasses,
+    #   lightly tinted sunglasses, strands of hair, and others.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] confidence
+    #   The confidence that the service has detected the presence of a face
+    #   occlusion.
+    #   @return [Float]
+    #
+    class FaceOccluded < Struct.new(
+      :value,
+      :confidence)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Object containing both the face metadata (stored in the backend
     # database), and facial attributes that are detected but aren't stored
     # in the database.
@@ -3936,13 +3980,14 @@ module Aws::Rekognition
     #   @return [String]
     #
     # @!attribute [rw] detection_attributes
-    #   An array of facial attributes that you want to be returned. This can
-    #   be the default list of attributes or all attributes. If you don't
-    #   specify a value for `Attributes` or if you specify `["DEFAULT"]`,
-    #   the API returns the following subset of facial attributes:
-    #   `BoundingBox`, `Confidence`, `Pose`, `Quality`, and `Landmarks`. If
-    #   you provide `["ALL"]`, all facial attributes are returned, but the
-    #   operation takes longer to complete.
+    #   An array of facial attributes you want to be returned. A `DEFAULT`
+    #   subset of facial attributes - `BoundingBox`, `Confidence`, `Pose`,
+    #   `Quality`, and `Landmarks` - will always be returned. You can
+    #   request for specific facial attributes (in addition to the default
+    #   list) - by using `["DEFAULT", "FACE_OCCLUDED"]` or just
+    #   `["FACE_OCCLUDED"]`. You can request for all facial attributes by
+    #   using `["ALL"]`. Requesting more attributes may increase response
+    #   time.
     #
     #   If you provide both, `["ALL", "DEFAULT"]`, the service uses a
     #   logical AND operator to determine which attributes to return (in

data/lib/aws-sdk-rekognition.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-rekognition/customizations'
 # @!group service
 module Aws::Rekognition
 
-  GEM_VERSION = '1.77.0'
+  GEM_VERSION = '1.78.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.77.0
+  version: 1.78.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core