# Amazon Rekognition Streaming
<a name="API_Types_Amazon_Rekognition_Streaming"></a>

The following data types are supported by Amazon Rekognition Streaming:
+  [BoundingBox](API_rekognitionstreaming_BoundingBox.md) 
+  [ChallengeConfig](API_rekognitionstreaming_ChallengeConfig.md) 
+  [ClientChallenge](API_rekognitionstreaming_ClientChallenge.md) 
+  [ClientSessionInformationEvent](API_rekognitionstreaming_ClientSessionInformationEvent.md) 
+  [ColorDisplayed](API_rekognitionstreaming_ColorDisplayed.md) 
+  [ColorSequence](API_rekognitionstreaming_ColorSequence.md) 
+  [DisconnectionEvent](API_rekognitionstreaming_DisconnectionEvent.md) 
+  [FaceMovementAndLightClientChallenge](API_rekognitionstreaming_FaceMovementAndLightClientChallenge.md) 
+  [FaceMovementAndLightServerChallenge](API_rekognitionstreaming_FaceMovementAndLightServerChallenge.md) 
+  [FreshnessColor](API_rekognitionstreaming_FreshnessColor.md) 
+  [InitialFace](API_rekognitionstreaming_InitialFace.md) 
+  [LivenessRequestStream](API_rekognitionstreaming_LivenessRequestStream.md) 
+  [LivenessResponseStream](API_rekognitionstreaming_LivenessResponseStream.md) 
+  [OvalParameters](API_rekognitionstreaming_OvalParameters.md) 
+  [ServerChallenge](API_rekognitionstreaming_ServerChallenge.md) 
+  [ServerSessionInformationEvent](API_rekognitionstreaming_ServerSessionInformationEvent.md) 
+  [SessionInformation](API_rekognitionstreaming_SessionInformation.md) 
+  [TargetFace](API_rekognitionstreaming_TargetFace.md) 
+  [VideoEvent](API_rekognitionstreaming_VideoEvent.md) 

# BoundingBox
<a name="API_rekognitionstreaming_BoundingBox"></a>

Identifies the bounding box around a given label, face, text, object of interest, or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). 

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. 

## Contents
<a name="API_rekognitionstreaming_BoundingBox_Contents"></a>

 ** Height **   <a name="rekognition-Type-rekognitionstreaming_BoundingBox-Height"></a>
Height of the bounding box as a ratio of the overall image height.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

 ** Left **   <a name="rekognition-Type-rekognitionstreaming_BoundingBox-Left"></a>
Left coordinate of the bounding box as a ratio of overall image width.  
Type: Float  
Valid Range: Minimum value of -1. Maximum value of 1.  
Required: Yes

 ** Top **   <a name="rekognition-Type-rekognitionstreaming_BoundingBox-Top"></a>
Top coordinate of the bounding box as a ratio of overall image height.  
Type: Float  
Valid Range: Minimum value of -1. Maximum value of 1.  
Required: Yes

 ** Width **   <a name="rekognition-Type-rekognitionstreaming_BoundingBox-Width"></a>
Width of the bounding box as a ratio of the overall image width.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_BoundingBox_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/BoundingBox) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/BoundingBox) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/BoundingBox) 

# ChallengeConfig
<a name="API_rekognitionstreaming_ChallengeConfig"></a>

Configuration options for Face Liveness challenges performed at the client side. 

## Contents
<a name="API_rekognitionstreaming_ChallengeConfig_Contents"></a>

 ** BlazeFaceDetectionThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-BlazeFaceDetectionThreshold"></a>
Threshold for face detection done using blaze face.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** FaceDistanceThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-FaceDistanceThreshold"></a>
Threshold for face distance threshold face liveness challenge.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** FaceDistanceThresholdMax **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-FaceDistanceThresholdMax"></a>
Threshold for the maximum distance that face can be from the camera before face oval match challenge starts.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** FaceDistanceThresholdMin **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-FaceDistanceThresholdMin"></a>
Threshold for the minimum distance that face can be from the camera before face oval match challenge starts.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** FaceIouHeightThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-FaceIouHeightThreshold"></a>
 Threshold for height during face IOU (Intersection over Union) match.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** FaceIouWidthThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-FaceIouWidthThreshold"></a>
Threshold for width during face IOU (Intersection over Union) match.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** OvalFitTimeout **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-OvalFitTimeout"></a>
Timeout limit in which the end-users need to fit in the oval, in miliseconds.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 10000.  
Required: No

 ** OvalHeightWidthRatio **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-OvalHeightWidthRatio"></a>
Height to width ratio of oval used for face oval match.  
Type: Float  
Required: No

 ** OvalIouHeightThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-OvalIouHeightThreshold"></a>
Threshold for height during oval IOU (Intersection over Union) match.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** OvalIouThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-OvalIouThreshold"></a>
Threshold for face oval match using IoU (Intersection over Union).  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** OvalIouWidthThreshold **   <a name="rekognition-Type-rekognitionstreaming_ChallengeConfig-OvalIouWidthThreshold"></a>
Threshold for width during oval IOU (Intersection over Union) match.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

## See Also
<a name="API_rekognitionstreaming_ChallengeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ChallengeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ChallengeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ChallengeConfig) 

# ClientChallenge
<a name="API_rekognitionstreaming_ClientChallenge"></a>

Object containing information for Face Liveness challenges performed at the client side.

## Contents
<a name="API_rekognitionstreaming_ClientChallenge_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** FaceMovementAndLightChallenge **   <a name="rekognition-Type-rekognitionstreaming_ClientChallenge-FaceMovementAndLightChallenge"></a>
Information about a face movement and light challenge type.  
Type: [FaceMovementAndLightClientChallenge](API_rekognitionstreaming_FaceMovementAndLightClientChallenge.md) object  
Required: No

## See Also
<a name="API_rekognitionstreaming_ClientChallenge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ClientChallenge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ClientChallenge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ClientChallenge) 

# ClientSessionInformationEvent
<a name="API_rekognitionstreaming_ClientSessionInformationEvent"></a>

Any information that the client needs to send for the streaming session. For face movement challenge, it will contain information like initial face position and target face position.

## Contents
<a name="API_rekognitionstreaming_ClientSessionInformationEvent_Contents"></a>

 ** Challenge **   <a name="rekognition-Type-rekognitionstreaming_ClientSessionInformationEvent-Challenge"></a>
Contains information on FaceMovementAndLightChellenge, TargetFace, and ColorDisplayed, for a given Challenge.  
Type: [ClientChallenge](API_rekognitionstreaming_ClientChallenge.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_ClientSessionInformationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ClientSessionInformationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ClientSessionInformationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ClientSessionInformationEvent) 

# ColorDisplayed
<a name="API_rekognitionstreaming_ColorDisplayed"></a>

Contains information regarding `SequenceNumber`, `CurrentColor`, `PreviousColor`, and `CurrentColorStartTimestamp`.

## Contents
<a name="API_rekognitionstreaming_ColorDisplayed_Contents"></a>

 ** CurrentColor **   <a name="rekognition-Type-rekognitionstreaming_ColorDisplayed-CurrentColor"></a>
 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).   
Type: [FreshnessColor](API_rekognitionstreaming_FreshnessColor.md) object  
Required: Yes

 ** CurrentColorStartTimestamp **   <a name="rekognition-Type-rekognitionstreaming_ColorDisplayed-CurrentColorStartTimestamp"></a>
Epoch timestamp of when the current color was displayed on the user screen.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: Yes

 ** SequenceNumber **   <a name="rekognition-Type-rekognitionstreaming_ColorDisplayed-SequenceNumber"></a>
The order in which the current color was displayed on the screen.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 50.  
Required: Yes

 ** PreviousColor **   <a name="rekognition-Type-rekognitionstreaming_ColorDisplayed-PreviousColor"></a>
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).   
Type: [FreshnessColor](API_rekognitionstreaming_FreshnessColor.md) object  
Required: No

## See Also
<a name="API_rekognitionstreaming_ColorDisplayed_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ColorDisplayed) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ColorDisplayed) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ColorDisplayed) 

# ColorSequence
<a name="API_rekognitionstreaming_ColorSequence"></a>

A color sequence to be displayed on the user’s screen. 

## Contents
<a name="API_rekognitionstreaming_ColorSequence_Contents"></a>

 ** DownscrollDuration **   <a name="rekognition-Type-rekognitionstreaming_ColorSequence-DownscrollDuration"></a>
Duration in milliseconds for which a given color in the color sequence will down-scroll before taking over full screen.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1000.  
Required: Yes

 ** FlatDisplayDuration **   <a name="rekognition-Type-rekognitionstreaming_ColorSequence-FlatDisplayDuration"></a>
Duration in milliseconds for which a given flat color in the color sequence will be displayed on the full screen.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1000.  
Required: Yes

 ** FreshnessColor **   <a name="rekognition-Type-rekognitionstreaming_ColorSequence-FreshnessColor"></a>
Represents the colors in a given ColorSequence to be flashed to the end user, with each color represented in RGB values.  
Type: [FreshnessColor](API_rekognitionstreaming_FreshnessColor.md) object  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_ColorSequence_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ColorSequence) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ColorSequence) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ColorSequence) 

# DisconnectionEvent
<a name="API_rekognitionstreaming_DisconnectionEvent"></a>

Contains information regarding if a disconnection event took place during the Face Liveness session. Disconnection events may indicate processing is complete at the server side.

## Contents
<a name="API_rekognitionstreaming_DisconnectionEvent_Contents"></a>

 ** TimestampMillis **   <a name="rekognition-Type-rekognitionstreaming_DisconnectionEvent-TimestampMillis"></a>
The timestamp that a disconnection event took place at.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_DisconnectionEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/DisconnectionEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/DisconnectionEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/DisconnectionEvent) 

# FaceMovementAndLightClientChallenge
<a name="API_rekognitionstreaming_FaceMovementAndLightClientChallenge"></a>

Holds information about the type of face movement and light challenges that need to be performed.

## Contents
<a name="API_rekognitionstreaming_FaceMovementAndLightClientChallenge_Contents"></a>

 ** ChallengeId **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-ChallengeId"></a>
An ID that uniquely identifies a challenge from a client.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** ColorDisplayed **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-ColorDisplayed"></a>
Contains information regarding SequenceNumber, CurrentColor, PreviousColor, and CurrentColorStartTimestamp for a challenge.  
Type: [ColorDisplayed](API_rekognitionstreaming_ColorDisplayed.md) object  
Required: No

 ** InitialFace **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-InitialFace"></a>
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.  
Type: [InitialFace](API_rekognitionstreaming_InitialFace.md) object  
Required: No

 ** TargetFace **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-TargetFace"></a>
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   
dimensions in the input stream. Contains start and end epoch timestamp of when the user was detected in this position.  
Type: [TargetFace](API_rekognitionstreaming_TargetFace.md) object  
Required: No

 ** VideoEndTimestamp **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-VideoEndTimestamp"></a>
Epoch timestamp indicating end of video recording.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: No

 ** VideoStartTimestamp **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightClientChallenge-VideoStartTimestamp"></a>
Epoch timestamp indicating start of video recording.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: No

## See Also
<a name="API_rekognitionstreaming_FaceMovementAndLightClientChallenge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/FaceMovementAndLightClientChallenge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/FaceMovementAndLightClientChallenge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/FaceMovementAndLightClientChallenge) 

# FaceMovementAndLightServerChallenge
<a name="API_rekognitionstreaming_FaceMovementAndLightServerChallenge"></a>

Contains information regarding the `OvalParameters` and `LightChallengeType` for a challenge.

## Contents
<a name="API_rekognitionstreaming_FaceMovementAndLightServerChallenge_Contents"></a>

 ** ChallengeConfig **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightServerChallenge-ChallengeConfig"></a>
Configurations for attributes of the Face Liveness movement and light challenges.  
Type: [ChallengeConfig](API_rekognitionstreaming_ChallengeConfig.md) object  
Required: Yes

 ** ColorSequences **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightServerChallenge-ColorSequences"></a>
Used to generate a list of color sequences to be displayed on a user's screen.  
Type: Array of [ColorSequence](API_rekognitionstreaming_ColorSequence.md) objects  
Required: Yes

 ** LightChallengeType **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightServerChallenge-LightChallengeType"></a>
Information on the type of colored light challenge.  
Type: String  
Valid Values: `SEQUENTIAL`   
Required: Yes

 ** OvalParameters **   <a name="rekognition-Type-rekognitionstreaming_FaceMovementAndLightServerChallenge-OvalParameters"></a>
The parameters needed for an oval to display and to complete oval match challenge.  
Type: [OvalParameters](API_rekognitionstreaming_OvalParameters.md) object  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_FaceMovementAndLightServerChallenge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/FaceMovementAndLightServerChallenge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/FaceMovementAndLightServerChallenge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/FaceMovementAndLightServerChallenge) 

# FreshnessColor
<a name="API_rekognitionstreaming_FreshnessColor"></a>

Represents the colors to be flashed to the end user, each color represented in RGB values.

## Contents
<a name="API_rekognitionstreaming_FreshnessColor_Contents"></a>

 ** RGB **   <a name="rekognition-Type-rekognitionstreaming_FreshnessColor-RGB"></a>
RGB values for a color to be flashed to the end user.  
Type: Array of integers  
Array Members: Fixed number of 3 items.  
Valid Range: Minimum value of 0. Maximum value of 255.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_FreshnessColor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/FreshnessColor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/FreshnessColor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/FreshnessColor) 

# InitialFace
<a name="API_rekognitionstreaming_InitialFace"></a>

 Contains bounding box of initial face position of the user on the device screen. Contains an epoch timestamp of when the user was detected in this position. Used for Face Liveness detection.

## Contents
<a name="API_rekognitionstreaming_InitialFace_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-rekognitionstreaming_InitialFace-BoundingBox"></a>
The bounding box for the initial face position of the user on the device screen.  
Type: [BoundingBox](API_rekognitionstreaming_BoundingBox.md) object  
Required: Yes

 ** InitialFaceDetectedTimestamp **   <a name="rekognition-Type-rekognitionstreaming_InitialFace-InitialFaceDetectedTimestamp"></a>
Timestamp that a face was initially detected at.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_InitialFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/InitialFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/InitialFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/InitialFace) 

# LivenessRequestStream
<a name="API_rekognitionstreaming_LivenessRequestStream"></a>

Contains information regarding video events and client session details for a Face Liveness verification request stream.

## Contents
<a name="API_rekognitionstreaming_LivenessRequestStream_Contents"></a>

 ** ClientSessionInformationEvent **   <a name="rekognition-Type-rekognitionstreaming_LivenessRequestStream-ClientSessionInformationEvent"></a>
Information event for the client session for a given Face Liveness request stream.  
Type: [ClientSessionInformationEvent](API_rekognitionstreaming_ClientSessionInformationEvent.md) object  
Required: No

 ** VideoEvent **   <a name="rekognition-Type-rekognitionstreaming_LivenessRequestStream-VideoEvent"></a>
Contains video events for a Face Liveness request stream.  
Type: [VideoEvent](API_rekognitionstreaming_VideoEvent.md) object  
Required: No

## See Also
<a name="API_rekognitionstreaming_LivenessRequestStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/LivenessRequestStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/LivenessRequestStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/LivenessRequestStream) 

# LivenessResponseStream
<a name="API_rekognitionstreaming_LivenessResponseStream"></a>

Contains information event details and exception information for a Face Liveness verification response stream.

## Contents
<a name="API_rekognitionstreaming_LivenessResponseStream_Contents"></a>

 ** DisconnectionEvent **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-DisconnectionEvent"></a>
Notification that disconnection event has occurred to a Face Liveness session.  
Type: [DisconnectionEvent](API_rekognitionstreaming_DisconnectionEvent.md) object  
Required: No

 ** InternalServerException **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-InternalServerException"></a>
Notification that an InternalServerException occurred during a Face Liveness session.  
Type: Exception  
HTTP Status Code: 500  
Required: No

 ** ServerSessionInformationEvent **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-ServerSessionInformationEvent"></a>
Details for a server session information event.  
Type: [ServerSessionInformationEvent](API_rekognitionstreaming_ServerSessionInformationEvent.md) object  
Required: No

 ** ServiceQuotaExceededException **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-ServiceQuotaExceededException"></a>
Notification that a ServiceQuotaExceededException occurred during a Face Liveness session.  
Type: Exception  
HTTP Status Code: 429  
Required: No

 ** ServiceUnavailableException **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-ServiceUnavailableException"></a>
Notification that a ServiceUnavailableException occurred during a Face Liveness session.  
Type: Exception  
HTTP Status Code: 503  
Required: No

 ** ThrottlingException **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-ThrottlingException"></a>
Notification that a ThrottlingException occurred during a Face Liveness session.  
Type: Exception  
HTTP Status Code: 429  
Required: No

 ** ValidationException **   <a name="rekognition-Type-rekognitionstreaming_LivenessResponseStream-ValidationException"></a>
Notification that a ValidationException occurred during a Face Liveness session.  
Type: Exception  
HTTP Status Code: 400  
Required: No

## See Also
<a name="API_rekognitionstreaming_LivenessResponseStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/LivenessResponseStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/LivenessResponseStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/LivenessResponseStream) 

# OvalParameters
<a name="API_rekognitionstreaming_OvalParameters"></a>

Oval parameters need for oval display to complete oval match challenge.

## Contents
<a name="API_rekognitionstreaming_OvalParameters_Contents"></a>

 ** CenterX **   <a name="rekognition-Type-rekognitionstreaming_OvalParameters-CenterX"></a>
X-axis co-ordinate of for center of oval  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 9999.  
Required: Yes

 ** CenterY **   <a name="rekognition-Type-rekognitionstreaming_OvalParameters-CenterY"></a>
Y-axis co-ordinate of for center of oval  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 9999.  
Required: Yes

 ** Height **   <a name="rekognition-Type-rekognitionstreaming_OvalParameters-Height"></a>
Height of the oval  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 9999.  
Required: Yes

 ** Width **   <a name="rekognition-Type-rekognitionstreaming_OvalParameters-Width"></a>
Width of the oval  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 9999.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_OvalParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/OvalParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/OvalParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/OvalParameters) 

# ServerChallenge
<a name="API_rekognitionstreaming_ServerChallenge"></a>

Information on the challenge sent by the server.

## Contents
<a name="API_rekognitionstreaming_ServerChallenge_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** FaceMovementAndLightChallenge **   <a name="rekognition-Type-rekognitionstreaming_ServerChallenge-FaceMovementAndLightChallenge"></a>
Paramteters and configuration information for the face movement and light sequence challenges.  
Type: [FaceMovementAndLightServerChallenge](API_rekognitionstreaming_FaceMovementAndLightServerChallenge.md) object  
Required: No

## See Also
<a name="API_rekognitionstreaming_ServerChallenge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ServerChallenge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ServerChallenge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ServerChallenge) 

# ServerSessionInformationEvent
<a name="API_rekognitionstreaming_ServerSessionInformationEvent"></a>

Event containing session information for the server.

## Contents
<a name="API_rekognitionstreaming_ServerSessionInformationEvent_Contents"></a>

 ** SessionInformation **   <a name="rekognition-Type-rekognitionstreaming_ServerSessionInformationEvent-SessionInformation"></a>
Contains the session information sent by the server..  
Type: [SessionInformation](API_rekognitionstreaming_SessionInformation.md) object  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_ServerSessionInformationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/ServerSessionInformationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/ServerSessionInformationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/ServerSessionInformationEvent) 

# SessionInformation
<a name="API_rekognitionstreaming_SessionInformation"></a>

Information required for the streaming session.

## Contents
<a name="API_rekognitionstreaming_SessionInformation_Contents"></a>

 ** Challenge **   <a name="rekognition-Type-rekognitionstreaming_SessionInformation-Challenge"></a>
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.  
Type: [ServerChallenge](API_rekognitionstreaming_ServerChallenge.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_SessionInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/SessionInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/SessionInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/SessionInformation) 

# TargetFace
<a name="API_rekognitionstreaming_TargetFace"></a>

Contains bounding box of face position of the user on the device screen at target location constructed for the challenge. This is generated using the random offsets provided by the server to the client at session start. Also contains start and end epoch timestamp of when the user was detected in this position.

## Contents
<a name="API_rekognitionstreaming_TargetFace_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-rekognitionstreaming_TargetFace-BoundingBox"></a>
A bounding box for the target face.  
Type: [BoundingBox](API_rekognitionstreaming_BoundingBox.md) object  
Required: Yes

 ** FaceDetectedInTargetPositionEndTimestamp **   <a name="rekognition-Type-rekognitionstreaming_TargetFace-FaceDetectedInTargetPositionEndTimestamp"></a>
Ending timestamp at which a face was detected in the target position.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: Yes

 ** FaceDetectedInTargetPositionStartTimestamp **   <a name="rekognition-Type-rekognitionstreaming_TargetFace-FaceDetectedInTargetPositionStartTimestamp"></a>
Starting timestamp at which a face was detected in the target position.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: Yes

## See Also
<a name="API_rekognitionstreaming_TargetFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/TargetFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/TargetFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/TargetFace) 

# VideoEvent
<a name="API_rekognitionstreaming_VideoEvent"></a>

Contains the video chunk blob.

## Contents
<a name="API_rekognitionstreaming_VideoEvent_Contents"></a>

 ** TimestampMillis **   <a name="rekognition-Type-rekognitionstreaming_VideoEvent-TimestampMillis"></a>
Milisecond timestamp for a video chunk in a video event.  
Type: Long  
Valid Range: Minimum value of 1640995200000. Maximum value of 2272147200000.  
Required: No

 ** VideoChunk **   <a name="rekognition-Type-rekognitionstreaming_VideoEvent-VideoChunk"></a>
The video chunk for a video event.  
Type: Base64-encoded binary data object  
Required: No

## See Also
<a name="API_rekognitionstreaming_VideoEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognitionstreaming-2022-05-30/VideoEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognitionstreaming-2022-05-30/VideoEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognitionstreaming-2022-05-30/VideoEvent)