RekognitionStreamingClient

Suggest an Edit

A real-time video processing service based on Rekognition. This section documents the API operations for Rekognition Face Liveness.

Amazon Rekognition Face Liveness

Installation

NPM
npm install @aws-sdk/client-rekognitionstreaming
Yarn
yarn add @aws-sdk/client-rekognitionstreaming
pnpm
pnpm add @aws-sdk/client-rekognitionstreaming

RekognitionStreamingClient Operations

Command
Summary
StartFaceLivenessSessionCommand

Starts a Face Liveness video stream and liveness detection process for a given session.

Requires sessionId, ChallengeVersions, VideoWidth, VideoHeight and a RequestEventStream as input. The event stream contains information about different events for the session, including the challenge information used for verification.

The maximum video size for Face Liveness is 10 MB. Face Liveness throws a ValidationException if the video does not match the necessary formatting and size parameters.

StartFaceLivenessSession supports the websockets and the AWS SDK for JavaScript .

RekognitionStreamingClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
eventStreamSerdeProvider
Optional
EventStreamSerdeProvider
The function that provides necessary utilities for generating and parsing event stream
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: RekognitionStreamingClientConfig