aws-sdk-rekognition 1.136.0 → 1.137.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a551e39c80b5341041fc89dfce9a3c3aac7ba40e61c66ef55f5f3fcb21a49a7c
-  data.tar.gz: 0f64b1df92c4631afbefeecab92e17807c8ea387eb6c788766342eae13ac5482
+  metadata.gz: d98f5019715baedad554ff921371a6292fe61635a76d1b6ce4a82a5bae5d042a
+  data.tar.gz: '02894b20b6a6d682b6d5497f79d465b88a5969bfa774ece7a592c75734706cf9'
 SHA512:
-  metadata.gz: 9b1d5cdf67fd268ee26a6ea13db7414119b0df723907ec2db9dcddd19602f8de3c3cbf7cf7dd2ea1af9a1d9c866765d44bfbf457e4f125b716d2e05bfd8f2c0e
-  data.tar.gz: da741d55dcbdede735651337cf60e31958b8ffb8ee4483763926b03c59aa33069b2df0737cceb471799548b88528688d6163b1feacbd3d6d8f6040833c15396d
+  metadata.gz: b4b7457b39de9f975a47aa3b7d38c18fa4af5048a1bfd3adc37ad6348cc1540590e18775b1a64ac03b813ceadfdd09d95305b0c7fb74982f53078207b6745b0b
+  data.tar.gz: b6e2f7f8da5411abde63dbd0b38de218a955c3fd77eaaa3c2637c4a6bcde58ae4d388b595ca81b4f8db2566cfaff8a382f8f929c2d1607382f58e21af709902e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.137.0 (2026-09-25)
+------------------
+
+* Feature - This release adds support for Feedback and Metadata in the GetFaceLivenessSessionResults response. Feedback returns codes explaining why a Face Liveness check produced its result. Metadata includes the client SDK type.
+
 1.136.0 (2026-09-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.136.0
+1.137.0

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

@@ -1195,6 +1195,18 @@ module Aws::Rekognition
     # is between 0 and 4. By default, it is set to 0. The limit is best
     # effort and based on the duration of the selfie-video.
     #
+    # You can use the `ChallengePreferences` option in the `Settings`
+    # parameter to choose between the 'FaceMovementAndLightChallenge' or
+    # FaceMovementChallenge' settings. See the [Shared Responsibility][1]
+    # page for details on guidance for which setting to choose between these
+    # two settings depending on your use case and preferences. This
+    # parameter is optional and if no parameter is provided, then the
+    # 'FaceMovementAndLightChallenge' settings is applied by default.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/face-liveness-shared-responsibility-model.html
+    #
     # @option params [String] :kms_key_id
     #   The identifier for your AWS Key Management Service key (AWS KMS key).
     #   Used to encrypt audit images and reference images.
@@ -1491,6 +1503,13 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Creates an Amazon Rekognition stream processor that you can use to
     # detect and recognize faces or to detect labels in a streaming video.
     #
@@ -1530,6 +1549,10 @@ module Aws::Rekognition
     # stream processor, you also require permission to perform the
     # `rekognition:TagResource` operation.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, Types::StreamProcessorInput] :input
     #   Kinesis video stream stream that provides the source streaming video.
     #   If you are using the AWS CLI, the parameter name is
@@ -2049,12 +2072,23 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Deletes the stream processor identified by `Name`. You assign the
     # 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`.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :name
     #   The name of the stream processor you want to delete.
     #
@@ -2559,11 +2593,22 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # 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.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :name
     #   Name of the stream processor for which you want information.
     #
@@ -4273,6 +4318,11 @@ module Aws::Rekognition
     # `CreateFaceLivenessSession`. Reference images are always returned when
     # possible.
     #
+    # For a session that has completed, the response can also include a
+    # `Feedback` list describing conditions that were detected in the
+    # selfie-video, such as low lighting or an obstructed face, and
+    # `Metadata` about the client that streamed the session.
+    #
     # @option params [required, String] :session_id
     #   A unique 128-bit UUID. This is used to uniquely identify the session
     #   and also acts as an idempotency token for all operations associated
@@ -4286,6 +4336,8 @@ module Aws::Rekognition
     #   * {Types::GetFaceLivenessSessionResultsResponse#reference_image #reference_image} => Types::AuditImage
     #   * {Types::GetFaceLivenessSessionResultsResponse#audit_images #audit_images} => Array<Types::AuditImage>
     #   * {Types::GetFaceLivenessSessionResultsResponse#challenge #challenge} => Types::Challenge
+    #   * {Types::GetFaceLivenessSessionResultsResponse#feedback #feedback} => Array<Types::FeedbackItem>
+    #   * {Types::GetFaceLivenessSessionResultsResponse#metadata #metadata} => Types::SessionMetadata
     #
     # @example Request syntax with placeholder values
     #
@@ -4317,6 +4369,10 @@ module Aws::Rekognition
     #   resp.audit_images[0].bounding_box.top #=> Float
     #   resp.challenge.type #=> String, one of "FaceMovementAndLightChallenge", "FaceMovementChallenge"
     #   resp.challenge.version #=> String
+    #   resp.feedback #=> Array
+    #   resp.feedback[0].code #=> String, one of "FACE_NOT_VISIBLE", "FACE_OBSTRUCTION_DETECTED", "LOW_VIDEO_QUALITY_DETECTED", "FACE_NOT_ALIGNED", "EYES_CLOSED_DETECTED", "LOW_LIGHTING_DETECTED", "HIGH_LIGHTING_DETECTED"
+    #   resp.feedback[0].message #=> String
+    #   resp.metadata.sdk_type #=> String
     #
     # @overload get_face_liveness_session_results(params = {})
     # @param [Hash] params ({})
@@ -4677,9 +4733,20 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Retrieves the results for a given media analysis job. Takes a `JobId`
     # returned by StartMediaAnalysisJob.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :job_id
     #   Unique identifier for the media analysis job for which you want to
     #   retrieve results.
@@ -6026,9 +6093,20 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Returns a list of media analysis jobs. Results are sorted by
     # `CreationTimestamp` in descending order.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [String] :next_token
     #   Pagination token, if the previous response was incomplete.
     #
@@ -6222,9 +6300,20 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Gets a list of stream processors that you have created with
     # CreateStreamProcessor.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [String] :next_token
     #   If the previous response was incomplete (because there are more stream
     #   processors to retrieve), Amazon Rekognition Video returns a pagination
@@ -7695,10 +7784,21 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Initiates a new media analysis job. Accepts a manifest file in an
     # Amazon S3 bucket. The output is a manifest file and a summary of the
     # manifest stored in the Amazon S3 bucket.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [String] :client_request_token
     #   Idempotency token used to prevent the accidental creation of duplicate
     #   versions. If you use the same token with multiple
@@ -8056,6 +8156,13 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Starts processing a stream processor. You create a stream processor by
     # calling CreateStreamProcessor. To tell `StartStreamProcessor` which
     # stream processor to start, use the value of the `Name` field specified
@@ -8065,6 +8172,10 @@ module Aws::Rekognition
     # you need to provide a `Start selector` and a `Stop selector` to
     # determine the length of the stream processing time.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :name
     #   The name of the stream processor to start processing.
     #
@@ -8280,9 +8391,20 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Stops a running stream processor that was created by
     # CreateStreamProcessor.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :name
     #   The name of a stream processor created by CreateStreamProcessor.
     #
@@ -8441,9 +8563,20 @@ module Aws::Rekognition
       req.send_request(options)
     end
 
+    # Service availability notice: Streaming Video and Bulk Image Analysis
+    # is no longer available to new customers. For more information, see
+    # [Rekognition feature availability changes][1].
+    #
+    #  **This change does not impact the availability of other Amazon
+    # Rekognition features.**
+    #
     # Allows you to update a stream processor. You can change some settings
     # and regions of interest and delete certain parameters.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/rekognition/latest/dg/rekognition-availability-changes.html
+    #
     # @option params [required, String] :name
     #   Name of the stream processor that you want to update.
     #
@@ -8525,7 +8658,7 @@ module Aws::Rekognition
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-rekognition'
-      context[:gem_version] = '1.136.0'
+      context[:gem_version] = '1.137.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -201,6 +201,10 @@ module Aws::Rekognition
     FaceRecordList = Shapes::ListShape.new(name: 'FaceRecordList')
     FaceSearchSettings = Shapes::StructureShape.new(name: 'FaceSearchSettings')
     FaceSearchSortBy = Shapes::StringShape.new(name: 'FaceSearchSortBy')
+    FeedbackCode = Shapes::StringShape.new(name: 'FeedbackCode')
+    FeedbackItem = Shapes::StructureShape.new(name: 'FeedbackItem')
+    FeedbackList = Shapes::ListShape.new(name: 'FeedbackList')
+    FeedbackMessage = Shapes::StringShape.new(name: 'FeedbackMessage')
     Float = Shapes::FloatShape.new(name: 'Float')
     FlowDefinitionArn = Shapes::StringShape.new(name: 'FlowDefinitionArn')
     Gender = Shapes::StructureShape.new(name: 'Gender')
@@ -417,6 +421,7 @@ module Aws::Rekognition
     S3Object = Shapes::StructureShape.new(name: 'S3Object')
     S3ObjectName = Shapes::StringShape.new(name: 'S3ObjectName')
     S3ObjectVersion = Shapes::StringShape.new(name: 'S3ObjectVersion')
+    SDKTypeString = Shapes::StringShape.new(name: 'SDKTypeString')
     SNSTopicArn = Shapes::StringShape.new(name: 'SNSTopicArn')
     SearchFacesByImageRequest = Shapes::StructureShape.new(name: 'SearchFacesByImageRequest')
     SearchFacesByImageResponse = Shapes::StructureShape.new(name: 'SearchFacesByImageResponse')
@@ -437,6 +442,7 @@ module Aws::Rekognition
     SegmentTypes = Shapes::ListShape.new(name: 'SegmentTypes')
     SegmentTypesInfo = Shapes::ListShape.new(name: 'SegmentTypesInfo')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
+    SessionMetadata = Shapes::StructureShape.new(name: 'SessionMetadata')
     SessionNotFoundException = Shapes::StructureShape.new(name: 'SessionNotFoundException')
     ShotSegment = Shapes::StructureShape.new(name: 'ShotSegment')
     Smile = Shapes::StructureShape.new(name: 'Smile')
@@ -1206,6 +1212,12 @@ module Aws::Rekognition
     FaceSearchSettings.add_member(:face_match_threshold, Shapes::ShapeRef.new(shape: Percent, location_name: "FaceMatchThreshold"))
     FaceSearchSettings.struct_class = Types::FaceSearchSettings
 
+    FeedbackItem.add_member(:code, Shapes::ShapeRef.new(shape: FeedbackCode, required: true, location_name: "Code"))
+    FeedbackItem.add_member(:message, Shapes::ShapeRef.new(shape: FeedbackMessage, required: true, location_name: "Message"))
+    FeedbackItem.struct_class = Types::FeedbackItem
+
+    FeedbackList.member = Shapes::ShapeRef.new(shape: FeedbackItem)
+
     Gender.add_member(:value, Shapes::ShapeRef.new(shape: GenderType, location_name: "Value"))
     Gender.add_member(:confidence, Shapes::ShapeRef.new(shape: Percent, location_name: "Confidence"))
     Gender.struct_class = Types::Gender
@@ -1293,6 +1305,8 @@ module Aws::Rekognition
     GetFaceLivenessSessionResultsResponse.add_member(:reference_image, Shapes::ShapeRef.new(shape: AuditImage, location_name: "ReferenceImage"))
     GetFaceLivenessSessionResultsResponse.add_member(:audit_images, Shapes::ShapeRef.new(shape: AuditImages, location_name: "AuditImages"))
     GetFaceLivenessSessionResultsResponse.add_member(:challenge, Shapes::ShapeRef.new(shape: Challenge, location_name: "Challenge"))
+    GetFaceLivenessSessionResultsResponse.add_member(:feedback, Shapes::ShapeRef.new(shape: FeedbackList, location_name: "Feedback"))
+    GetFaceLivenessSessionResultsResponse.add_member(:metadata, Shapes::ShapeRef.new(shape: SessionMetadata, location_name: "Metadata"))
     GetFaceLivenessSessionResultsResponse.struct_class = Types::GetFaceLivenessSessionResultsResponse
 
     GetFaceSearchRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location_name: "JobId"))
@@ -1921,6 +1935,9 @@ module Aws::Rekognition
 
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    SessionMetadata.add_member(:sdk_type, Shapes::ShapeRef.new(shape: SDKTypeString, required: true, location_name: "SDKType"))
+    SessionMetadata.struct_class = Types::SessionMetadata
+
     SessionNotFoundException.struct_class = Types::SessionNotFoundException
 
     ShotSegment.add_member(:index, Shapes::ShapeRef.new(shape: ULong, location_name: "Index"))

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

@@ -3196,6 +3196,28 @@ module Aws::Rekognition
       include Aws::Structure
     end
 
+    # Describes a condition that was detected in the Face Liveness video and
+    # that contributed to the confidence score returned for the session.
+    #
+    # @!attribute [rw] code
+    #   A code identifying the condition that was detected during the Face
+    #   Liveness session.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   A human-readable description of the detected condition, suitable for
+    #   displaying to an end user before they retry a Face Liveness check.
+    #   Use `Code` rather than this message for programmatic decisions,
+    #   because the message text can change.
+    #   @return [String]
+    #
+    class FeedbackItem < Struct.new(
+      :code,
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The predicted gender of a detected face.
     #
     # Amazon Rekognition makes gender binary (male/female) predictions based
@@ -3680,13 +3702,28 @@ module Aws::Rekognition
     #   Liveness check.
     #   @return [Types::Challenge]
     #
+    # @!attribute [rw] feedback
+    #   A list of conditions that were detected in the Face Liveness video
+    #   and that contributed to the returned `Confidence` score. Each item
+    #   contains a code and a human-readable message. Feedback is returned
+    #   only for sessions with a `Status` of `SUCCEEDED`, and the list is
+    #   empty when no such conditions were detected.
+    #   @return [Array<Types::FeedbackItem>]
+    #
+    # @!attribute [rw] metadata
+    #   Metadata about the client that streamed the video for the Face
+    #   Liveness session.
+    #   @return [Types::SessionMetadata]
+    #
     class GetFaceLivenessSessionResultsResponse < Struct.new(
       :session_id,
       :status,
       :confidence,
       :reference_image,
       :audit_images,
-      :challenge)
+      :challenge,
+      :feedback,
+      :metadata)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -6831,6 +6868,26 @@ module Aws::Rekognition
     #
     class ServiceQuotaExceededException < Aws::EmptyStructure; end
 
+    # Contains metadata about the client that streamed the video for a Face
+    # Liveness session.
+    #
+    # @!attribute [rw] sdk_type
+    #   The type of SDK that was used to stream the video for the Face
+    #   Liveness session.
+    #
+    #   <note markdown="1"> This value is self-reported by the client that streamed the session,
+    #   and Amazon Rekognition doesn't verify it. Don't rely on it for
+    #   authentication, authorization, or any other security decision.
+    #
+    #    </note>
+    #   @return [String]
+    #
+    class SessionMetadata < Struct.new(
+      :sdk_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Occurs when a given sessionId is not found.
     #
     class SessionNotFoundException < Aws::EmptyStructure; end

data/lib/aws-sdk-rekognition.rb

@@ -55,7 +55,7 @@ module Aws::Rekognition
   autoload :EndpointProvider, 'aws-sdk-rekognition/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-rekognition/endpoints'
 
-  GEM_VERSION = '1.136.0'
+  GEM_VERSION = '1.137.0'
 
 end
 

data/sig/client.rbs

@@ -676,6 +676,8 @@ module Aws
         def reference_image: () -> Types::AuditImage
         def audit_images: () -> ::Array[Types::AuditImage]
         def challenge: () -> Types::Challenge
+        def feedback: () -> ::Array[Types::FeedbackItem]
+        def metadata: () -> Types::SessionMetadata
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_face_liveness_session_results-instance_method
       def get_face_liveness_session_results: (

data/sig/types.rbs

@@ -816,6 +816,12 @@ module Aws::Rekognition
       SENSITIVE: []
     end
 
+    class FeedbackItem
+      attr_accessor code: ("FACE_NOT_VISIBLE" | "FACE_OBSTRUCTION_DETECTED" | "LOW_VIDEO_QUALITY_DETECTED" | "FACE_NOT_ALIGNED" | "EYES_CLOSED_DETECTED" | "LOW_LIGHTING_DETECTED" | "HIGH_LIGHTING_DETECTED")
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class Gender
       attr_accessor value: ("Male" | "Female")
       attr_accessor confidence: ::Float
@@ -928,6 +934,8 @@ module Aws::Rekognition
       attr_accessor reference_image: Types::AuditImage
       attr_accessor audit_images: ::Array[Types::AuditImage]
       attr_accessor challenge: Types::Challenge
+      attr_accessor feedback: ::Array[Types::FeedbackItem]
+      attr_accessor metadata: Types::SessionMetadata
       SENSITIVE: []
     end
 
@@ -1722,6 +1730,11 @@ module Aws::Rekognition
     class ServiceQuotaExceededException < Aws::EmptyStructure
     end
 
+    class SessionMetadata
+      attr_accessor sdk_type: ::String
+      SENSITIVE: []
+    end
+
     class SessionNotFoundException < Aws::EmptyStructure
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rekognition
 version: !ruby/object:Gem::Version
-  version: 1.136.0
+  version: 1.137.0
 platform: ruby
 authors:
 - Amazon Web Services