@aws-sdk/client-rekognitionstreaming 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -25,18 +25,22 @@ export declare class AccessDeniedException extends __BaseException {
  */
 export interface BoundingBox {
     /**
+     * @public
      * <p>Width of the bounding box as a ratio of the overall image width.</p>
      */
     Width: number | undefined;
     /**
+     * @public
      * <p>Height of the bounding box as a ratio of the overall image height.</p>
      */
     Height: number | undefined;
     /**
+     * @public
      * <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
      */
     Left: number | undefined;
     /**
+     * @public
      * <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
      */
     Top: number | undefined;
@@ -47,44 +51,54 @@ export interface BoundingBox {
  */
 export interface ChallengeConfig {
     /**
+     * @public
      * <p>Threshold for face detection done using blaze face.</p>
      */
     BlazeFaceDetectionThreshold?: number;
     /**
+     * @public
      * <p>Threshold for the minimum distance that face can be from the camera before face oval
      *       match challenge starts.</p>
      */
     FaceDistanceThresholdMin?: number;
     /**
+     * @public
      * <p>Threshold for face distance threshold face liveness challenge.</p>
      */
     FaceDistanceThreshold?: number;
     /**
+     * @public
      * <p>Threshold for the maximum distance that face can be from the camera before face oval
      *       match challenge starts.</p>
      */
     FaceDistanceThresholdMax?: number;
     /**
+     * @public
      * <p>Threshold for face oval match using IoU (Intersection over Union).</p>
      */
     OvalIouThreshold?: number;
     /**
+     * @public
      * <p>Height to width ratio of oval used for face oval match.</p>
      */
     OvalHeightWidthRatio?: number;
     /**
+     * @public
      * <p>Threshold for width during oval IOU (Intersection over Union) match.</p>
      */
     OvalIouWidthThreshold?: number;
     /**
+     * @public
      * <p>Threshold for height during oval IOU (Intersection over Union) match.</p>
      */
     OvalIouHeightThreshold?: number;
     /**
+     * @public
      * <p>Threshold for width during face IOU (Intersection over Union) match.</p>
      */
     FaceIouWidthThreshold?: number;
     /**
+     * @public
      * <p> Threshold for height during face IOU (Intersection over Union) match.</p>
      */
     FaceIouHeightThreshold?: number;
@@ -95,6 +109,7 @@ export interface ChallengeConfig {
  */
 export interface FreshnessColor {
     /**
+     * @public
      * <p>RGB values for a color to be flashed to the end user.</p>
      */
     RGB: number[] | undefined;
@@ -106,18 +121,22 @@ export interface FreshnessColor {
  */
 export interface ColorDisplayed {
     /**
+     * @public
      * <p> The current color being displayed on the screen (flat or downscrolled). It will contain a separate RGB list having 3 elements (each element can have values between 0 to 255). </p>
      */
     CurrentColor: FreshnessColor | undefined;
     /**
+     * @public
      * <p>The previous color displayed on screen (flat or downscrolled). It will contain a separate RGB list having 3 elements (each element can have values between 0 to 255). </p>
      */
     PreviousColor?: FreshnessColor;
     /**
+     * @public
      * <p>The order in which the current color was displayed on the screen.</p>
      */
     SequenceNumber: number | undefined;
     /**
+     * @public
      * <p>Epoch timestamp of when the current color was displayed on the user screen.</p>
      */
     CurrentColorStartTimestamp: number | undefined;
@@ -130,10 +149,12 @@ export interface ColorDisplayed {
  */
 export interface InitialFace {
     /**
+     * @public
      * <p>The bounding box for the initial face position of the user on the device screen.</p>
      */
     BoundingBox: BoundingBox | undefined;
     /**
+     * @public
      * <p>Timestamp that a face was initially detected at.</p>
      */
     InitialFaceDetectedTimestamp: number | undefined;
@@ -147,14 +168,17 @@ export interface InitialFace {
  */
 export interface TargetFace {
     /**
+     * @public
      * <p>A bounding box for the target face.</p>
      */
     BoundingBox: BoundingBox | undefined;
     /**
+     * @public
      * <p>Starting timestamp at which a face was detected in the target position.</p>
      */
     FaceDetectedInTargetPositionStartTimestamp: number | undefined;
     /**
+     * @public
      * <p>Ending timestamp at which a face was detected in the target position.</p>
      */
     FaceDetectedInTargetPositionEndTimestamp: number | undefined;
@@ -166,24 +190,29 @@ export interface TargetFace {
  */
 export interface FaceMovementAndLightClientChallenge {
     /**
+     * @public
      * <p>An ID that uniquely identifies a challenge from a client.</p>
      */
     ChallengeId: string | undefined;
     /**
+     * @public
      * <p>Epoch timestamp indicating start of video recording.</p>
      */
     VideoStartTimestamp?: number;
     /**
+     * @public
      * <p>Epoch timestamp indicating end of video recording.</p>
      */
     VideoEndTimestamp?: number;
     /**
+     * @public
      * <p>Contains the bounding box of the initial face position for the user on the device screen.
      *       Also contains an epoch timestamp of when the user was detected in this position. Used for Face
      *       Liveness detection.</p>
      */
     InitialFace?: InitialFace;
     /**
+     * @public
      * <p>Contains the face position bounding box for the user on the device's screen, set at the
      *       target location constructed for the challenge. Generated using a precise oval location
      *       depending on the provided video </p>
@@ -192,6 +221,7 @@ export interface FaceMovementAndLightClientChallenge {
      */
     TargetFace?: TargetFace;
     /**
+     * @public
      * <p>Contains information regarding SequenceNumber, CurrentColor, PreviousColor, and CurrentColorStartTimestamp for a challenge.</p>
      */
     ColorDisplayed?: ColorDisplayed;
@@ -207,12 +237,16 @@ export type ClientChallenge = ClientChallenge.FaceMovementAndLightChallengeMembe
  */
 export declare namespace ClientChallenge {
     /**
+     * @public
      * <p>Information about a face movement and light challenge type.</p>
      */
     interface FaceMovementAndLightChallengeMember {
         FaceMovementAndLightChallenge: FaceMovementAndLightClientChallenge;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         FaceMovementAndLightChallenge?: never;
         $unknown: [string, any];
@@ -230,6 +264,7 @@ export declare namespace ClientChallenge {
  */
 export interface ClientSessionInformationEvent {
     /**
+     * @public
      * <p>Contains information on FaceMovementAndLightChellenge, TargetFace, and ColorDisplayed, for a given Challenge.</p>
      */
     Challenge: ClientChallenge | undefined;
@@ -240,14 +275,17 @@ export interface ClientSessionInformationEvent {
  */
 export interface ColorSequence {
     /**
+     * @public
      * <p>Represents the colors in a given ColorSequence to be flashed to the end user, with each color represented in RGB values.</p>
      */
     FreshnessColor: FreshnessColor | undefined;
     /**
+     * @public
      * <p>Duration in milliseconds for which a given color in the color sequence will down-scroll before taking over full screen.</p>
      */
     DownscrollDuration: number | undefined;
     /**
+     * @public
      * <p>Duration in milliseconds for which a given flat color in the color sequence will be displayed on the full screen.</p>
      */
     FlatDisplayDuration: number | undefined;
@@ -259,6 +297,7 @@ export interface ColorSequence {
  */
 export interface DisconnectionEvent {
     /**
+     * @public
      * <p>The timestamp that a disconnection event took place at.</p>
      */
     TimestampMillis: number | undefined;
@@ -280,18 +319,22 @@ export type LightChallengeType = (typeof LightChallengeType)[keyof typeof LightC
  */
 export interface OvalParameters {
     /**
+     * @public
      * <p>Width of the oval</p>
      */
     Width: number | undefined;
     /**
+     * @public
      * <p>Height of the oval</p>
      */
     Height: number | undefined;
     /**
+     * @public
      * <p>X-axis co-ordinate of  for center of oval</p>
      */
     CenterX: number | undefined;
     /**
+     * @public
      * <p>Y-axis co-ordinate of  for center of oval</p>
      */
     CenterY: number | undefined;
@@ -303,18 +346,22 @@ export interface OvalParameters {
  */
 export interface FaceMovementAndLightServerChallenge {
     /**
+     * @public
      * <p>The parameters needed for an oval to display and to complete oval match challenge.</p>
      */
     OvalParameters: OvalParameters | undefined;
     /**
+     * @public
      * <p>Information on the type of colored light challenge.</p>
      */
     LightChallengeType: LightChallengeType | string | undefined;
     /**
+     * @public
      * <p>Configurations for attributes of the Face Liveness movement and light challenges.</p>
      */
     ChallengeConfig: ChallengeConfig | undefined;
     /**
+     * @public
      * <p>Used to generate a list of color sequences to be displayed on a user's screen.</p>
      */
     ColorSequences: ColorSequence[] | undefined;
@@ -339,10 +386,12 @@ export declare class InternalServerException extends __BaseException {
  */
 export interface VideoEvent {
     /**
+     * @public
      * <p>The video chunk for a video event.</p>
      */
     VideoChunk?: Uint8Array;
     /**
+     * @public
      * <p>Milisecond timestamp for a video chunk in a video event.</p>
      */
     TimestampMillis?: number;
@@ -357,6 +406,7 @@ export type LivenessRequestStream = LivenessRequestStream.ClientSessionInformati
  */
 export declare namespace LivenessRequestStream {
     /**
+     * @public
      * <p>Contains video events for a Face Liveness request stream.</p>
      */
     interface VideoEventMember {
@@ -365,6 +415,7 @@ export declare namespace LivenessRequestStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Information event for the client session for a given Face Liveness request stream.</p>
      */
     interface ClientSessionInformationEventMember {
@@ -372,6 +423,9 @@ export declare namespace LivenessRequestStream {
         ClientSessionInformationEvent: ClientSessionInformationEvent;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         VideoEvent?: never;
         ClientSessionInformationEvent?: never;
@@ -394,12 +448,16 @@ export type ServerChallenge = ServerChallenge.FaceMovementAndLightChallengeMembe
  */
 export declare namespace ServerChallenge {
     /**
+     * @public
      * <p>Paramteters and configuration information for the face movement and light sequence challenges.</p>
      */
     interface FaceMovementAndLightChallengeMember {
         FaceMovementAndLightChallenge: FaceMovementAndLightServerChallenge;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         FaceMovementAndLightChallenge?: never;
         $unknown: [string, any];
@@ -416,6 +474,7 @@ export declare namespace ServerChallenge {
  */
 export interface SessionInformation {
     /**
+     * @public
      * <p>Object containing information of Face Liveness challenge to be performed by the client. The information is used to construct the challenges at the client's SDK.</p>
      */
     Challenge: ServerChallenge | undefined;
@@ -426,6 +485,7 @@ export interface SessionInformation {
  */
 export interface ServerSessionInformationEvent {
     /**
+     * @public
      * <p>Contains the session information sent by the server..</p>
      */
     SessionInformation: SessionInformation | undefined;
@@ -501,6 +561,7 @@ export type LivenessResponseStream = LivenessResponseStream.DisconnectionEventMe
  */
 export declare namespace LivenessResponseStream {
     /**
+     * @public
      * <p>Details for a server session information event.</p>
      */
     interface ServerSessionInformationEventMember {
@@ -514,6 +575,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that disconnection event has occurred to a Face Liveness session.</p>
      */
     interface DisconnectionEventMember {
@@ -527,6 +589,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that a ValidationException occurred during a Face Liveness session.</p>
      */
     interface ValidationExceptionMember {
@@ -540,6 +603,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that an InternalServerException occurred during a Face Liveness session.</p>
      */
     interface InternalServerExceptionMember {
@@ -553,6 +617,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that a ThrottlingException occurred during a Face Liveness session.</p>
      */
     interface ThrottlingExceptionMember {
@@ -566,6 +631,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that a ServiceQuotaExceededException occurred during a Face Liveness session.</p>
      */
     interface ServiceQuotaExceededExceptionMember {
@@ -579,6 +645,7 @@ export declare namespace LivenessResponseStream {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Notification that a ServiceUnavailableException occurred during a Face Liveness session.</p>
      */
     interface ServiceUnavailableExceptionMember {
@@ -591,6 +658,9 @@ export declare namespace LivenessResponseStream {
         ServiceUnavailableException: ServiceUnavailableException;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         ServerSessionInformationEvent?: never;
         DisconnectionEvent?: never;
@@ -632,25 +702,30 @@ export declare class SessionNotFoundException extends __BaseException {
  */
 export interface StartFaceLivenessSessionRequest {
     /**
+     * @public
      * <p>A unique 128-bit UUID. Used to uniquely identify the session and also acta as an
      *       idempotency token for all operations associated with the session.</p>
      */
     SessionId: string | undefined;
     /**
+     * @public
      * <p>The width of the video object included in a request to start a Face Liveness
      *       session.</p>
      */
     VideoWidth: string | undefined;
     /**
+     * @public
      * <p>The height of the video object included in a request to start a Face Liveness
      *       session.</p>
      */
     VideoHeight: string | undefined;
     /**
+     * @public
      * <p>String containing comma separated list of challenge versions supported by client.</p>
      */
     ChallengeVersions: string | undefined;
     /**
+     * @public
      * <p>Information regarding the request stream for a Face Liveness session.</p>
      */
     LivenessRequestStream?: AsyncIterable<LivenessRequestStream>;
@@ -660,10 +735,12 @@ export interface StartFaceLivenessSessionRequest {
  */
 export interface StartFaceLivenessSessionResponse {
     /**
+     * @public
      * <p>The ID that identifies a Face Liveness session.</p>
      */
     SessionId: string | undefined;
     /**
+     * @public
      * <p>Information regarding the response stream for a Face Liveness session.</p>
      */
     LivenessResponseStream?: AsyncIterable<LivenessResponseStream>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rekognitionstreaming",
   "description": "AWS SDK for JavaScript Rekognitionstreaming Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,18 +21,18 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/eventstream-handler-node": "3.378.0",
     "@aws-sdk/middleware-eventstream": "3.379.1",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/middleware-websocket": "3.379.1",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",