@aws-sdk/client-rekognitionstreaming 3.305.0 → 3.308.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/README.md +23 -8
  2. package/dist-cjs/RekognitionStreaming.js +0 -15
  3. package/dist-cjs/RekognitionStreamingClient.js +2 -0
  4. package/dist-cjs/commands/index.js +0 -1
  5. package/dist-cjs/endpoint/ruleset.js +3 -3
  6. package/dist-cjs/models/models_0.js +20 -12
  7. package/dist-cjs/protocols/Aws_restJson1.js +56 -85
  8. package/dist-es/RekognitionStreaming.js +0 -15
  9. package/dist-es/RekognitionStreamingClient.js +2 -0
  10. package/dist-es/commands/index.js +0 -1
  11. package/dist-es/endpoint/ruleset.js +3 -3
  12. package/dist-es/models/models_0.js +18 -9
  13. package/dist-es/protocols/Aws_restJson1.js +56 -83
  14. package/dist-types/RekognitionStreaming.d.ts +31 -7
  15. package/dist-types/RekognitionStreamingClient.d.ts +24 -3
  16. package/dist-types/commands/StartFaceLivenessSessionCommand.d.ts +109 -0
  17. package/dist-types/commands/index.d.ts +0 -1
  18. package/dist-types/models/models_0.d.ts +308 -37
  19. package/dist-types/protocols/Aws_restJson1.d.ts +0 -3
  20. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  21. package/dist-types/runtimeConfig.d.ts +1 -1
  22. package/dist-types/ts3.4/RekognitionStreaming.d.ts +0 -17
  23. package/dist-types/ts3.4/RekognitionStreamingClient.d.ts +2 -10
  24. package/dist-types/ts3.4/commands/index.d.ts +0 -1
  25. package/dist-types/ts3.4/models/models_0.d.ts +48 -25
  26. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +0 -12
  27. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  28. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  29. package/package.json +36 -35
  30. package/dist-cjs/commands/StartStreamingLivenessSessionCommand.js +0 -50
  31. package/dist-es/commands/StartStreamingLivenessSessionCommand.js +0 -46
  32. package/dist-types/commands/StartStreamingLivenessSessionCommand.d.ts +0 -39
  33. package/dist-types/ts3.4/commands/StartStreamingLivenessSessionCommand.d.ts +0 -41
@@ -2,6 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
2
2
  import { RekognitionStreamingServiceException as __BaseException } from "./RekognitionStreamingServiceException";
3
3
  /**
4
4
  * @public
5
+ * <p>Occurs when the client isn't authorized to perform the action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
7
8
  readonly name: "AccessDeniedException";
@@ -15,61 +16,199 @@ export declare class AccessDeniedException extends __BaseException {
15
16
  }
16
17
  /**
17
18
  * @public
19
+ * <p>Identifies the bounding box around a given label, face, text, object of interest, or
20
+ * personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates
21
+ * representing the top and left sides of the bounding box. Note that the upper-left corner of
22
+ * the image is the origin (0,0). </p>
23
+ * <p>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).</p>
24
+ * <p>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. </p>
18
25
  */
19
26
  export interface BoundingBox {
27
+ /**
28
+ * <p>Width of the bounding box as a ratio of the overall image width.</p>
29
+ */
20
30
  Width: number | undefined;
31
+ /**
32
+ * <p>Height of the bounding box as a ratio of the overall image height.</p>
33
+ */
21
34
  Height: number | undefined;
35
+ /**
36
+ * <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
37
+ */
22
38
  Left: number | undefined;
39
+ /**
40
+ * <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
41
+ */
23
42
  Top: number | undefined;
24
43
  }
25
44
  /**
26
45
  * @public
46
+ * <p>Configuration options for Face Liveness challenges performed at the client side. </p>
47
+ */
48
+ export interface ChallengeConfig {
49
+ /**
50
+ * <p>Threshold for face detection done using blaze face.</p>
51
+ */
52
+ BlazeFaceDetectionThreshold?: number;
53
+ /**
54
+ * <p>Threshold for the minimum distance that face can be from the camera before face oval
55
+ * match challenge starts.</p>
56
+ */
57
+ FaceDistanceThresholdMin?: number;
58
+ /**
59
+ * <p>Threshold for face distance threshold face liveness challenge.</p>
60
+ */
61
+ FaceDistanceThreshold?: number;
62
+ /**
63
+ * <p>Threshold for the maximum distance that face can be from the camera before face oval
64
+ * match challenge starts.</p>
65
+ */
66
+ FaceDistanceThresholdMax?: number;
67
+ /**
68
+ * <p>Threshold for face oval match using IoU (Intersection over Union).</p>
69
+ */
70
+ OvalIouThreshold?: number;
71
+ /**
72
+ * <p>Height to width ratio of oval used for face oval match.</p>
73
+ */
74
+ OvalHeightWidthRatio?: number;
75
+ /**
76
+ * <p>Threshold for width during oval IOU (Intersection over Union) match.</p>
77
+ */
78
+ OvalIouWidthThreshold?: number;
79
+ /**
80
+ * <p>Threshold for height during oval IOU (Intersection over Union) match.</p>
81
+ */
82
+ OvalIouHeightThreshold?: number;
83
+ /**
84
+ * <p>Threshold for width during face IOU (Intersection over Union) match.</p>
85
+ */
86
+ FaceIouWidthThreshold?: number;
87
+ /**
88
+ * <p> Threshold for height during face IOU (Intersection over Union) match.</p>
89
+ */
90
+ FaceIouHeightThreshold?: number;
91
+ }
92
+ /**
93
+ * @public
94
+ * <p>Represents the colors to be flashed to the end user, each color represented in RGB values.</p>
27
95
  */
28
96
  export interface FreshnessColor {
97
+ /**
98
+ * <p>RGB values for a color to be flashed to the end user.</p>
99
+ */
29
100
  RGB: number[] | undefined;
30
101
  }
31
102
  /**
32
103
  * @public
104
+ * <p>Contains information regarding <code>SequenceNumber</code>, <code>CurrentColor</code>,
105
+ * <code>PreviousColor</code>, and <code>CurrentColorStartTimestamp</code>.</p>
33
106
  */
34
107
  export interface ColorDisplayed {
108
+ /**
109
+ * <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>
110
+ */
35
111
  CurrentColor: FreshnessColor | undefined;
112
+ /**
113
+ * <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>
114
+ */
36
115
  PreviousColor?: FreshnessColor;
116
+ /**
117
+ * <p>The order in which the current color was displayed on the screen.</p>
118
+ */
37
119
  SequenceNumber: number | undefined;
120
+ /**
121
+ * <p>Epoch timestamp of when the current color was displayed on the user screen.</p>
122
+ */
38
123
  CurrentColorStartTimestamp: number | undefined;
39
124
  }
40
125
  /**
41
126
  * @public
127
+ * <p> Contains bounding box of initial face position of the user on the device screen.
128
+ * Contains an epoch timestamp of when the user was detected in this position. Used for Face
129
+ * Liveness detection.</p>
42
130
  */
43
131
  export interface InitialFace {
132
+ /**
133
+ * <p>The bounding box for the initial face position of the user on the device screen.</p>
134
+ */
44
135
  BoundingBox: BoundingBox | undefined;
136
+ /**
137
+ * <p>Timestamp that a face was initially detected at.</p>
138
+ */
45
139
  InitialFaceDetectedTimestamp: number | undefined;
46
140
  }
47
141
  /**
48
142
  * @public
143
+ * <p>Contains bounding box of face position of the user on the device screen at target
144
+ * location constructed for the challenge. This is generated using the random offsets provided by
145
+ * the server to the client at session start. Also contains start and end epoch timestamp of when
146
+ * the user was detected in this position.</p>
49
147
  */
50
148
  export interface TargetFace {
149
+ /**
150
+ * <p>A bounding box for the target face.</p>
151
+ */
51
152
  BoundingBox: BoundingBox | undefined;
153
+ /**
154
+ * <p>Starting timestamp at which a face was detected in the target position.</p>
155
+ */
52
156
  FaceDetectedInTargetPositionStartTimestamp: number | undefined;
157
+ /**
158
+ * <p>Ending timestamp at which a face was detected in the target position.</p>
159
+ */
53
160
  FaceDetectedInTargetPositionEndTimestamp: number | undefined;
54
161
  }
55
162
  /**
56
163
  * @public
164
+ * <p>Holds information about the type of face movement and light challenges that need to be
165
+ * performed.</p>
57
166
  */
58
167
  export interface FaceMovementAndLightClientChallenge {
168
+ /**
169
+ * <p>An ID that uniquely identifies a challenge from a client.</p>
170
+ */
59
171
  ChallengeId: string | undefined;
172
+ /**
173
+ * <p>Epoch timestamp indicating start of video recording.</p>
174
+ */
60
175
  VideoStartTimestamp?: number;
176
+ /**
177
+ * <p>Epoch timestamp indicating end of video recording.</p>
178
+ */
179
+ VideoEndTimestamp?: number;
180
+ /**
181
+ * <p>Contains the bounding box of the initial face position for the user on the device screen.
182
+ * Also contains an epoch timestamp of when the user was detected in this position. Used for Face
183
+ * Liveness detection.</p>
184
+ */
61
185
  InitialFace?: InitialFace;
186
+ /**
187
+ * <p>Contains the face position bounding box for the user on the device's screen, set at the
188
+ * target location constructed for the challenge. Generated using a precise oval location
189
+ * depending on the provided video </p>
190
+ * <p>dimensions in the input stream. Contains start and end epoch timestamp of when the user
191
+ * was detected in this position.</p>
192
+ */
62
193
  TargetFace?: TargetFace;
194
+ /**
195
+ * <p>Contains information regarding SequenceNumber, CurrentColor, PreviousColor, and CurrentColorStartTimestamp for a challenge.</p>
196
+ */
63
197
  ColorDisplayed?: ColorDisplayed;
64
198
  }
65
199
  /**
66
200
  * @public
201
+ * <p>Object containing information for Face Liveness challenges performed at the client
202
+ * side.</p>
67
203
  */
68
204
  export type ClientChallenge = ClientChallenge.FaceMovementAndLightChallengeMember | ClientChallenge.$UnknownMember;
69
205
  /**
70
206
  * @public
71
207
  */
72
208
  export declare namespace ClientChallenge {
209
+ /**
210
+ * <p>Information about a face movement and light challenge type.</p>
211
+ */
73
212
  interface FaceMovementAndLightChallengeMember {
74
213
  FaceMovementAndLightChallenge: FaceMovementAndLightClientChallenge;
75
214
  $unknown?: never;
@@ -86,31 +225,42 @@ export declare namespace ClientChallenge {
86
225
  }
87
226
  /**
88
227
  * @public
89
- */
90
- export interface DeviceInformation {
91
- VideoHeight: number | undefined;
92
- VideoWidth: number | undefined;
93
- ClientSDKVersion: string | undefined;
94
- }
95
- /**
96
- * @public
228
+ * <p>Any information that the client needs to send for the streaming session. For face movement challenge,
229
+ * it will contain information like initial face position and target face position.</p>
97
230
  */
98
231
  export interface ClientSessionInformationEvent {
99
- DeviceInformation: DeviceInformation | undefined;
232
+ /**
233
+ * <p>Contains information on FaceMovementAndLightChellenge, TargetFace, and ColorDisplayed, for a given Challenge.</p>
234
+ */
100
235
  Challenge: ClientChallenge | undefined;
101
236
  }
102
237
  /**
103
238
  * @public
239
+ * <p>A color sequence to be displayed on the user’s screen. </p>
104
240
  */
105
241
  export interface ColorSequence {
242
+ /**
243
+ * <p>Represents the colors in a given ColorSequence to be flashed to the end user, with each color represented in RGB values.</p>
244
+ */
106
245
  FreshnessColor: FreshnessColor | undefined;
246
+ /**
247
+ * <p>Duration in milliseconds for which a given color in the color sequence will down-scroll before taking over full screen.</p>
248
+ */
107
249
  DownscrollDuration: number | undefined;
250
+ /**
251
+ * <p>Duration in milliseconds for which a given flat color in the color sequence will be displayed on the full screen.</p>
252
+ */
108
253
  FlatDisplayDuration: number | undefined;
109
254
  }
110
255
  /**
111
256
  * @public
257
+ * <p>Contains information regarding if a disconnection event took place
258
+ * during the Face Liveness session. Disconnection events may indicate processing is complete at the server side.</p>
112
259
  */
113
260
  export interface DisconnectionEvent {
261
+ /**
262
+ * <p>The timestamp that a disconnection event took place at.</p>
263
+ */
114
264
  TimestampMillis: number | undefined;
115
265
  }
116
266
  /**
@@ -119,7 +269,6 @@ export interface DisconnectionEvent {
119
269
  */
120
270
  export declare const LightChallengeType: {
121
271
  readonly SEQUENTIAL: "SEQUENTIAL";
122
- readonly SIMULTANEOUS: "SIMULTANEOUS";
123
272
  };
124
273
  /**
125
274
  * @public
@@ -127,22 +276,52 @@ export declare const LightChallengeType: {
127
276
  export type LightChallengeType = (typeof LightChallengeType)[keyof typeof LightChallengeType];
128
277
  /**
129
278
  * @public
279
+ * <p>Oval parameters need for oval display to complete oval match challenge.</p>
130
280
  */
131
- export interface OvalScaleFactors {
281
+ export interface OvalParameters {
282
+ /**
283
+ * <p>Width of the oval</p>
284
+ */
132
285
  Width: number | undefined;
286
+ /**
287
+ * <p>Height of the oval</p>
288
+ */
289
+ Height: number | undefined;
290
+ /**
291
+ * <p>X-axis co-ordinate of for center of oval</p>
292
+ */
133
293
  CenterX: number | undefined;
294
+ /**
295
+ * <p>Y-axis co-ordinate of for center of oval</p>
296
+ */
134
297
  CenterY: number | undefined;
135
298
  }
136
299
  /**
137
300
  * @public
301
+ * <p>Contains information regarding the <code>OvalParameters</code> and
302
+ * <code>LightChallengeType</code> for a challenge.</p>
138
303
  */
139
304
  export interface FaceMovementAndLightServerChallenge {
140
- OvalScaleFactors: OvalScaleFactors | undefined;
305
+ /**
306
+ * <p>The parameters needed for an oval to display and to complete oval match challenge.</p>
307
+ */
308
+ OvalParameters: OvalParameters | undefined;
309
+ /**
310
+ * <p>Information on the type of colored light challenge.</p>
311
+ */
141
312
  LightChallengeType: LightChallengeType | string | undefined;
313
+ /**
314
+ * <p>Configurations for attributes of the Face Liveness movement and light challenges.</p>
315
+ */
316
+ ChallengeConfig: ChallengeConfig | undefined;
317
+ /**
318
+ * <p>Used to generate a list of color sequences to be displayed on a user's screen.</p>
319
+ */
142
320
  ColorSequences: ColorSequence[] | undefined;
143
321
  }
144
322
  /**
145
323
  * @public
324
+ * <p>Unexpected error during processing of request.</p>
146
325
  */
147
326
  export declare class InternalServerException extends __BaseException {
148
327
  readonly name: "InternalServerException";
@@ -156,24 +335,38 @@ export declare class InternalServerException extends __BaseException {
156
335
  }
157
336
  /**
158
337
  * @public
338
+ * <p>Contains the video chunk blob.</p>
159
339
  */
160
340
  export interface VideoEvent {
341
+ /**
342
+ * <p>The video chunk for a video event.</p>
343
+ */
161
344
  VideoChunk?: Uint8Array;
345
+ /**
346
+ * <p>Milisecond timestamp for a video chunk in a video event.</p>
347
+ */
162
348
  TimestampMillis?: number;
163
349
  }
164
350
  /**
165
351
  * @public
352
+ * <p>Contains information regarding video events and client session details for a Face Liveness verification request stream.</p>
166
353
  */
167
354
  export type LivenessRequestStream = LivenessRequestStream.ClientSessionInformationEventMember | LivenessRequestStream.VideoEventMember | LivenessRequestStream.$UnknownMember;
168
355
  /**
169
356
  * @public
170
357
  */
171
358
  export declare namespace LivenessRequestStream {
359
+ /**
360
+ * <p>Contains video events for a Face Liveness request stream.</p>
361
+ */
172
362
  interface VideoEventMember {
173
363
  VideoEvent: VideoEvent;
174
364
  ClientSessionInformationEvent?: never;
175
365
  $unknown?: never;
176
366
  }
367
+ /**
368
+ * <p>Information event for the client session for a given Face Liveness request stream.</p>
369
+ */
177
370
  interface ClientSessionInformationEventMember {
178
371
  VideoEvent?: never;
179
372
  ClientSessionInformationEvent: ClientSessionInformationEvent;
@@ -193,12 +386,16 @@ export declare namespace LivenessRequestStream {
193
386
  }
194
387
  /**
195
388
  * @public
389
+ * <p>Information on the challenge sent by the server.</p>
196
390
  */
197
391
  export type ServerChallenge = ServerChallenge.FaceMovementAndLightChallengeMember | ServerChallenge.$UnknownMember;
198
392
  /**
199
393
  * @public
200
394
  */
201
395
  export declare namespace ServerChallenge {
396
+ /**
397
+ * <p>Paramteters and configuration information for the face movement and light sequence challenges.</p>
398
+ */
202
399
  interface FaceMovementAndLightChallengeMember {
203
400
  FaceMovementAndLightChallenge: FaceMovementAndLightServerChallenge;
204
401
  $unknown?: never;
@@ -215,18 +412,27 @@ export declare namespace ServerChallenge {
215
412
  }
216
413
  /**
217
414
  * @public
415
+ * <p>Information required for the streaming session.</p>
218
416
  */
219
417
  export interface SessionInformation {
418
+ /**
419
+ * <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>
420
+ */
220
421
  Challenge: ServerChallenge | undefined;
221
422
  }
222
423
  /**
223
424
  * @public
425
+ * <p>Event containing session information for the server.</p>
224
426
  */
225
427
  export interface ServerSessionInformationEvent {
428
+ /**
429
+ * <p>Contains the session information sent by the server..</p>
430
+ */
226
431
  SessionInformation: SessionInformation | undefined;
227
432
  }
228
433
  /**
229
434
  * @public
435
+ * <p>Occurs when a request would cause a service quota to be exceeded.</p>
230
436
  */
231
437
  export declare class ServiceQuotaExceededException extends __BaseException {
232
438
  readonly name: "ServiceQuotaExceededException";
@@ -240,6 +446,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
240
446
  }
241
447
  /**
242
448
  * @public
449
+ * <p>Service-wide throttling to recover from an operational event or service is not able to scale.</p>
450
+ */
451
+ export declare class ServiceUnavailableException extends __BaseException {
452
+ readonly name: "ServiceUnavailableException";
453
+ readonly $fault: "server";
454
+ Message?: string;
455
+ Code?: string;
456
+ /**
457
+ * @internal
458
+ */
459
+ constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
460
+ }
461
+ /**
462
+ * @public
463
+ * <p>A request was denied due to request throttling. Occurs when too many requests were made by a user
464
+ * (exceeding their service quota), the service isn't able to scale, or a service-wide throttling was done to recover from an operational event.</p>
243
465
  */
244
466
  export declare class ThrottlingException extends __BaseException {
245
467
  readonly name: "ThrottlingException";
@@ -253,6 +475,11 @@ export declare class ThrottlingException extends __BaseException {
253
475
  }
254
476
  /**
255
477
  * @public
478
+ * <p>The input fails to satisfy the constraints specified by the service. Potential reasons
479
+ * inlcude: video quality or size is invalid, video container format not supported, video does
480
+ * not have enough information - no person detected in video, request couldn't be parsed or is
481
+ * invalid, session has expired or is invalid, S3 bucket is invalid/in another AWS region, KMS
482
+ * Key is invalid.</p>
256
483
  */
257
484
  export declare class ValidationException extends __BaseException {
258
485
  readonly name: "ValidationException";
@@ -266,12 +493,16 @@ export declare class ValidationException extends __BaseException {
266
493
  }
267
494
  /**
268
495
  * @public
496
+ * <p>Contains information event details and exception information for a Face Liveness verification response stream.</p>
269
497
  */
270
- export type LivenessResponseStream = LivenessResponseStream.DisconnectionEventMember | LivenessResponseStream.InternalServerExceptionMember | LivenessResponseStream.ServerSessionInformationEventMember | LivenessResponseStream.ServiceQuotaExceededExceptionMember | LivenessResponseStream.ThrottlingExceptionMember | LivenessResponseStream.ValidationExceptionMember | LivenessResponseStream.$UnknownMember;
498
+ export type LivenessResponseStream = LivenessResponseStream.DisconnectionEventMember | LivenessResponseStream.InternalServerExceptionMember | LivenessResponseStream.ServerSessionInformationEventMember | LivenessResponseStream.ServiceQuotaExceededExceptionMember | LivenessResponseStream.ServiceUnavailableExceptionMember | LivenessResponseStream.ThrottlingExceptionMember | LivenessResponseStream.ValidationExceptionMember | LivenessResponseStream.$UnknownMember;
271
499
  /**
272
500
  * @public
273
501
  */
274
502
  export declare namespace LivenessResponseStream {
503
+ /**
504
+ * <p>Details for a server session information event.</p>
505
+ */
275
506
  interface ServerSessionInformationEventMember {
276
507
  ServerSessionInformationEvent: ServerSessionInformationEvent;
277
508
  DisconnectionEvent?: never;
@@ -279,8 +510,12 @@ export declare namespace LivenessResponseStream {
279
510
  InternalServerException?: never;
280
511
  ThrottlingException?: never;
281
512
  ServiceQuotaExceededException?: never;
513
+ ServiceUnavailableException?: never;
282
514
  $unknown?: never;
283
515
  }
516
+ /**
517
+ * <p>Notification that disconnection event has occurred to a Face Liveness session.</p>
518
+ */
284
519
  interface DisconnectionEventMember {
285
520
  ServerSessionInformationEvent?: never;
286
521
  DisconnectionEvent: DisconnectionEvent;
@@ -288,8 +523,12 @@ export declare namespace LivenessResponseStream {
288
523
  InternalServerException?: never;
289
524
  ThrottlingException?: never;
290
525
  ServiceQuotaExceededException?: never;
526
+ ServiceUnavailableException?: never;
291
527
  $unknown?: never;
292
528
  }
529
+ /**
530
+ * <p>Notification that a ValidationException occurred during a Face Liveness session.</p>
531
+ */
293
532
  interface ValidationExceptionMember {
294
533
  ServerSessionInformationEvent?: never;
295
534
  DisconnectionEvent?: never;
@@ -297,8 +536,12 @@ export declare namespace LivenessResponseStream {
297
536
  InternalServerException?: never;
298
537
  ThrottlingException?: never;
299
538
  ServiceQuotaExceededException?: never;
539
+ ServiceUnavailableException?: never;
300
540
  $unknown?: never;
301
541
  }
542
+ /**
543
+ * <p>Notification that an InternalServerException occurred during a Face Liveness session.</p>
544
+ */
302
545
  interface InternalServerExceptionMember {
303
546
  ServerSessionInformationEvent?: never;
304
547
  DisconnectionEvent?: never;
@@ -306,8 +549,12 @@ export declare namespace LivenessResponseStream {
306
549
  InternalServerException: InternalServerException;
307
550
  ThrottlingException?: never;
308
551
  ServiceQuotaExceededException?: never;
552
+ ServiceUnavailableException?: never;
309
553
  $unknown?: never;
310
554
  }
555
+ /**
556
+ * <p>Notification that a ThrottlingException occurred during a Face Liveness session.</p>
557
+ */
311
558
  interface ThrottlingExceptionMember {
312
559
  ServerSessionInformationEvent?: never;
313
560
  DisconnectionEvent?: never;
@@ -315,8 +562,12 @@ export declare namespace LivenessResponseStream {
315
562
  InternalServerException?: never;
316
563
  ThrottlingException: ThrottlingException;
317
564
  ServiceQuotaExceededException?: never;
565
+ ServiceUnavailableException?: never;
318
566
  $unknown?: never;
319
567
  }
568
+ /**
569
+ * <p>Notification that a ServiceQuotaExceededException occurred during a Face Liveness session.</p>
570
+ */
320
571
  interface ServiceQuotaExceededExceptionMember {
321
572
  ServerSessionInformationEvent?: never;
322
573
  DisconnectionEvent?: never;
@@ -324,6 +575,20 @@ export declare namespace LivenessResponseStream {
324
575
  InternalServerException?: never;
325
576
  ThrottlingException?: never;
326
577
  ServiceQuotaExceededException: ServiceQuotaExceededException;
578
+ ServiceUnavailableException?: never;
579
+ $unknown?: never;
580
+ }
581
+ /**
582
+ * <p>Notification that a ServiceUnavailableException occurred during a Face Liveness session.</p>
583
+ */
584
+ interface ServiceUnavailableExceptionMember {
585
+ ServerSessionInformationEvent?: never;
586
+ DisconnectionEvent?: never;
587
+ ValidationException?: never;
588
+ InternalServerException?: never;
589
+ ThrottlingException?: never;
590
+ ServiceQuotaExceededException?: never;
591
+ ServiceUnavailableException: ServiceUnavailableException;
327
592
  $unknown?: never;
328
593
  }
329
594
  interface $UnknownMember {
@@ -333,6 +598,7 @@ export declare namespace LivenessResponseStream {
333
598
  InternalServerException?: never;
334
599
  ThrottlingException?: never;
335
600
  ServiceQuotaExceededException?: never;
601
+ ServiceUnavailableException?: never;
336
602
  $unknown: [string, any];
337
603
  }
338
604
  interface Visitor<T> {
@@ -342,12 +608,14 @@ export declare namespace LivenessResponseStream {
342
608
  InternalServerException: (value: InternalServerException) => T;
343
609
  ThrottlingException: (value: ThrottlingException) => T;
344
610
  ServiceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
611
+ ServiceUnavailableException: (value: ServiceUnavailableException) => T;
345
612
  _: (name: string, value: any) => T;
346
613
  }
347
614
  const visit: <T>(value: LivenessResponseStream, visitor: Visitor<T>) => T;
348
615
  }
349
616
  /**
350
617
  * @public
618
+ * <p>Occurs when the given <code>sessionId</code> is not found.</p>
351
619
  */
352
620
  export declare class SessionNotFoundException extends __BaseException {
353
621
  readonly name: "SessionNotFoundException";
@@ -363,30 +631,41 @@ export declare class SessionNotFoundException extends __BaseException {
363
631
  * @public
364
632
  */
365
633
  export interface StartFaceLivenessSessionRequest {
634
+ /**
635
+ * <p>A unique 128-bit UUID. Used to uniquely identify the session and also acta as an
636
+ * idempotency token for all operations associated with the session.</p>
637
+ */
366
638
  SessionId: string | undefined;
367
- ClientSDKVersion: string | undefined;
639
+ /**
640
+ * <p>The width of the video object included in a request to start a Face Liveness
641
+ * session.</p>
642
+ */
643
+ VideoWidth: string | undefined;
644
+ /**
645
+ * <p>The height of the video object included in a request to start a Face Liveness
646
+ * session.</p>
647
+ */
648
+ VideoHeight: string | undefined;
649
+ /**
650
+ * <p>String containing comma separated list of challenge versions supported by client.</p>
651
+ */
652
+ ChallengeVersions: string | undefined;
653
+ /**
654
+ * <p>Information regarding the request stream for a Face Liveness session.</p>
655
+ */
368
656
  LivenessRequestStream?: AsyncIterable<LivenessRequestStream>;
369
657
  }
370
658
  /**
371
659
  * @public
372
660
  */
373
661
  export interface StartFaceLivenessSessionResponse {
662
+ /**
663
+ * <p>The ID that identifies a Face Liveness session.</p>
664
+ */
374
665
  SessionId: string | undefined;
375
- LivenessResponseStream?: AsyncIterable<LivenessResponseStream>;
376
- }
377
- /**
378
- * @public
379
- */
380
- export interface StartStreamingLivenessSessionRequest {
381
- SessionId: string | undefined;
382
- ClientSDKVersion: string | undefined;
383
- LivenessRequestStream?: AsyncIterable<LivenessRequestStream>;
384
- }
385
- /**
386
- * @public
387
- */
388
- export interface StartStreamingLivenessSessionResponse {
389
- SessionId: string | undefined;
666
+ /**
667
+ * <p>Information regarding the response stream for a Face Liveness session.</p>
668
+ */
390
669
  LivenessResponseStream?: AsyncIterable<LivenessResponseStream>;
391
670
  }
392
671
  /**
@@ -405,11 +684,3 @@ export declare const StartFaceLivenessSessionRequestFilterSensitiveLog: (obj: St
405
684
  * @internal
406
685
  */
407
686
  export declare const StartFaceLivenessSessionResponseFilterSensitiveLog: (obj: StartFaceLivenessSessionResponse) => any;
408
- /**
409
- * @internal
410
- */
411
- export declare const StartStreamingLivenessSessionRequestFilterSensitiveLog: (obj: StartStreamingLivenessSessionRequest) => any;
412
- /**
413
- * @internal
414
- */
415
- export declare const StartStreamingLivenessSessionResponseFilterSensitiveLog: (obj: StartStreamingLivenessSessionResponse) => any;
@@ -1,8 +1,5 @@
1
1
  import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
2
2
  import { EventStreamSerdeContext as __EventStreamSerdeContext, SerdeContext as __SerdeContext } from "@aws-sdk/types";
3
3
  import { StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput } from "../commands/StartFaceLivenessSessionCommand";
4
- import { StartStreamingLivenessSessionCommandInput, StartStreamingLivenessSessionCommandOutput } from "../commands/StartStreamingLivenessSessionCommand";
5
4
  export declare const serializeAws_restJson1StartFaceLivenessSessionCommand: (input: StartFaceLivenessSessionCommandInput, context: __SerdeContext & __EventStreamSerdeContext) => Promise<__HttpRequest>;
6
- export declare const serializeAws_restJson1StartStreamingLivenessSessionCommand: (input: StartStreamingLivenessSessionCommandInput, context: __SerdeContext & __EventStreamSerdeContext) => Promise<__HttpRequest>;
7
5
  export declare const deserializeAws_restJson1StartFaceLivenessSessionCommand: (output: __HttpResponse, context: __SerdeContext & __EventStreamSerdeContext) => Promise<StartFaceLivenessSessionCommandOutput>;
8
- export declare const deserializeAws_restJson1StartStreamingLivenessSessionCommand: (output: __HttpResponse, context: __SerdeContext & __EventStreamSerdeContext) => Promise<StartStreamingLivenessSessionCommandOutput>;
@@ -28,7 +28,7 @@ export declare const getRuntimeConfig: (config: RekognitionStreamingClientConfig
28
28
  disableHostPrefix: boolean;
29
29
  serviceId: string;
30
30
  logger: import("@aws-sdk/types").Logger;
31
- endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
31
+ endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
32
32
  endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
33
33
  logger?: import("@aws-sdk/types").Logger | undefined;
34
34
  }) => import("@aws-sdk/types").EndpointV2;
@@ -28,7 +28,7 @@ export declare const getRuntimeConfig: (config: RekognitionStreamingClientConfig
28
28
  disableHostPrefix: boolean;
29
29
  serviceId: string;
30
30
  logger: import("@aws-sdk/types").Logger;
31
- endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
31
+ endpoint?: ((string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>) & (string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | import("@aws-sdk/types").Provider<string> | import("@aws-sdk/types").EndpointV2 | import("@aws-sdk/types").Provider<import("@aws-sdk/types").EndpointV2>)) | undefined;
32
32
  endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
33
33
  logger?: import("@aws-sdk/types").Logger | undefined;
34
34
  }) => import("@aws-sdk/types").EndpointV2;