@aws-sdk/client-rekognitionstreaming 3.534.0 → 3.535.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.
@@ -10,7 +10,6 @@ export interface RekognitionStreaming {
10
10
  startFaceLivenessSession(args: StartFaceLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceLivenessSessionCommandOutput) => void): void;
11
11
  }
12
12
  /**
13
- * @public
14
13
  * <p>A real-time video processing service based on Rekognition. This section documents the API
15
14
  * operations for Rekognition Face Liveness.</p>
16
15
  * <p>
@@ -33,6 +32,7 @@ export interface RekognitionStreaming {
33
32
  * </p>
34
33
  * </li>
35
34
  * </ul>
35
+ * @public
36
36
  */
37
37
  export declare class RekognitionStreaming extends RekognitionStreamingClient implements RekognitionStreaming {
38
38
  }
@@ -164,7 +164,6 @@ export type RekognitionStreamingClientResolvedConfigType = __SmithyResolvedConfi
164
164
  export interface RekognitionStreamingClientResolvedConfig extends RekognitionStreamingClientResolvedConfigType {
165
165
  }
166
166
  /**
167
- * @public
168
167
  * <p>A real-time video processing service based on Rekognition. This section documents the API
169
168
  * operations for Rekognition Face Liveness.</p>
170
169
  * <p>
@@ -187,6 +186,7 @@ export interface RekognitionStreamingClientResolvedConfig extends RekognitionStr
187
186
  * </p>
188
187
  * </li>
189
188
  * </ul>
189
+ * @public
190
190
  */
191
191
  export declare class RekognitionStreamingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RekognitionStreamingClientResolvedConfig> {
192
192
  /**
@@ -22,10 +22,10 @@ export interface StartFaceLivenessSessionCommandOutput extends StartFaceLiveness
22
22
  }
23
23
  declare const StartFaceLivenessSessionCommand_base: {
24
24
  new (input: StartFaceLivenessSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput, RekognitionStreamingClientResolvedConfig, StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput>;
25
+ new (__0_0: StartFaceLivenessSessionCommandInput): import("@smithy/smithy-client").CommandImpl<StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput, RekognitionStreamingClientResolvedConfig, StartFaceLivenessSessionCommandInput, StartFaceLivenessSessionCommandOutput>;
25
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
27
  };
27
28
  /**
28
- * @public
29
29
  * <p>Starts a Face Liveness video stream and liveness detection process for a given
30
30
  * session.</p>
31
31
  * <p>Requires <code>sessionId</code>, <code>ChallengeVersions</code>, <code>VideoWidth</code>,
@@ -204,6 +204,7 @@ declare const StartFaceLivenessSessionCommand_base: {
204
204
  * @throws {@link RekognitionStreamingServiceException}
205
205
  * <p>Base exception class for all service exceptions from RekognitionStreaming service.</p>
206
206
  *
207
+ * @public
207
208
  */
208
209
  export declare class StartFaceLivenessSessionCommand extends StartFaceLivenessSessionCommand_base {
209
210
  }
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { RekognitionStreamingServiceException as __BaseException } from "./RekognitionStreamingServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>Occurs when the client isn't authorized to perform the action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -15,226 +15,226 @@ export declare class AccessDeniedException extends __BaseException {
15
15
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
16
16
  }
17
17
  /**
18
- * @public
19
18
  * <p>Identifies the bounding box around a given label, face, text, object of interest, or
20
19
  * personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates
21
20
  * representing the top and left sides of the bounding box. Note that the upper-left corner of
22
21
  * the image is the origin (0,0). </p>
23
22
  * <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
23
  * <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>
24
+ * @public
25
25
  */
26
26
  export interface BoundingBox {
27
27
  /**
28
- * @public
29
28
  * <p>Width of the bounding box as a ratio of the overall image width.</p>
29
+ * @public
30
30
  */
31
31
  Width: number | undefined;
32
32
  /**
33
- * @public
34
33
  * <p>Height of the bounding box as a ratio of the overall image height.</p>
34
+ * @public
35
35
  */
36
36
  Height: number | undefined;
37
37
  /**
38
- * @public
39
38
  * <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
39
+ * @public
40
40
  */
41
41
  Left: number | undefined;
42
42
  /**
43
- * @public
44
43
  * <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
44
+ * @public
45
45
  */
46
46
  Top: number | undefined;
47
47
  }
48
48
  /**
49
- * @public
50
49
  * <p>Configuration options for Face Liveness challenges performed at the client side. </p>
50
+ * @public
51
51
  */
52
52
  export interface ChallengeConfig {
53
53
  /**
54
- * @public
55
54
  * <p>Threshold for face detection done using blaze face.</p>
55
+ * @public
56
56
  */
57
57
  BlazeFaceDetectionThreshold?: number;
58
58
  /**
59
- * @public
60
59
  * <p>Threshold for the minimum distance that face can be from the camera before face oval
61
60
  * match challenge starts.</p>
61
+ * @public
62
62
  */
63
63
  FaceDistanceThresholdMin?: number;
64
64
  /**
65
- * @public
66
65
  * <p>Threshold for face distance threshold face liveness challenge.</p>
66
+ * @public
67
67
  */
68
68
  FaceDistanceThreshold?: number;
69
69
  /**
70
- * @public
71
70
  * <p>Threshold for the maximum distance that face can be from the camera before face oval
72
71
  * match challenge starts.</p>
72
+ * @public
73
73
  */
74
74
  FaceDistanceThresholdMax?: number;
75
75
  /**
76
- * @public
77
76
  * <p>Threshold for face oval match using IoU (Intersection over Union).</p>
77
+ * @public
78
78
  */
79
79
  OvalIouThreshold?: number;
80
80
  /**
81
- * @public
82
81
  * <p>Height to width ratio of oval used for face oval match.</p>
82
+ * @public
83
83
  */
84
84
  OvalHeightWidthRatio?: number;
85
85
  /**
86
- * @public
87
86
  * <p>Threshold for width during oval IOU (Intersection over Union) match.</p>
87
+ * @public
88
88
  */
89
89
  OvalIouWidthThreshold?: number;
90
90
  /**
91
- * @public
92
91
  * <p>Threshold for height during oval IOU (Intersection over Union) match.</p>
92
+ * @public
93
93
  */
94
94
  OvalIouHeightThreshold?: number;
95
95
  /**
96
- * @public
97
96
  * <p>Threshold for width during face IOU (Intersection over Union) match.</p>
97
+ * @public
98
98
  */
99
99
  FaceIouWidthThreshold?: number;
100
100
  /**
101
- * @public
102
101
  * <p> Threshold for height during face IOU (Intersection over Union) match.</p>
102
+ * @public
103
103
  */
104
104
  FaceIouHeightThreshold?: number;
105
105
  /**
106
- * @public
107
106
  * <p>Timeout limit in which the end-users need to fit in the oval, in miliseconds.</p>
107
+ * @public
108
108
  */
109
109
  OvalFitTimeout?: number;
110
110
  }
111
111
  /**
112
- * @public
113
112
  * <p>Represents the colors to be flashed to the end user, each color represented in RGB values.</p>
113
+ * @public
114
114
  */
115
115
  export interface FreshnessColor {
116
116
  /**
117
- * @public
118
117
  * <p>RGB values for a color to be flashed to the end user.</p>
118
+ * @public
119
119
  */
120
120
  RGB: number[] | undefined;
121
121
  }
122
122
  /**
123
- * @public
124
123
  * <p>Contains information regarding <code>SequenceNumber</code>, <code>CurrentColor</code>,
125
124
  * <code>PreviousColor</code>, and <code>CurrentColorStartTimestamp</code>.</p>
125
+ * @public
126
126
  */
127
127
  export interface ColorDisplayed {
128
128
  /**
129
- * @public
130
129
  * <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>
130
+ * @public
131
131
  */
132
132
  CurrentColor: FreshnessColor | undefined;
133
133
  /**
134
- * @public
135
134
  * <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>
135
+ * @public
136
136
  */
137
137
  PreviousColor?: FreshnessColor;
138
138
  /**
139
- * @public
140
139
  * <p>The order in which the current color was displayed on the screen.</p>
140
+ * @public
141
141
  */
142
142
  SequenceNumber: number | undefined;
143
143
  /**
144
- * @public
145
144
  * <p>Epoch timestamp of when the current color was displayed on the user screen.</p>
145
+ * @public
146
146
  */
147
147
  CurrentColorStartTimestamp: number | undefined;
148
148
  }
149
149
  /**
150
- * @public
151
150
  * <p> Contains bounding box of initial face position of the user on the device screen.
152
151
  * Contains an epoch timestamp of when the user was detected in this position. Used for Face
153
152
  * Liveness detection.</p>
153
+ * @public
154
154
  */
155
155
  export interface InitialFace {
156
156
  /**
157
- * @public
158
157
  * <p>The bounding box for the initial face position of the user on the device screen.</p>
158
+ * @public
159
159
  */
160
160
  BoundingBox: BoundingBox | undefined;
161
161
  /**
162
- * @public
163
162
  * <p>Timestamp that a face was initially detected at.</p>
163
+ * @public
164
164
  */
165
165
  InitialFaceDetectedTimestamp: number | undefined;
166
166
  }
167
167
  /**
168
- * @public
169
168
  * <p>Contains bounding box of face position of the user on the device screen at target
170
169
  * location constructed for the challenge. This is generated using the random offsets provided by
171
170
  * the server to the client at session start. Also contains start and end epoch timestamp of when
172
171
  * the user was detected in this position.</p>
172
+ * @public
173
173
  */
174
174
  export interface TargetFace {
175
175
  /**
176
- * @public
177
176
  * <p>A bounding box for the target face.</p>
177
+ * @public
178
178
  */
179
179
  BoundingBox: BoundingBox | undefined;
180
180
  /**
181
- * @public
182
181
  * <p>Starting timestamp at which a face was detected in the target position.</p>
182
+ * @public
183
183
  */
184
184
  FaceDetectedInTargetPositionStartTimestamp: number | undefined;
185
185
  /**
186
- * @public
187
186
  * <p>Ending timestamp at which a face was detected in the target position.</p>
187
+ * @public
188
188
  */
189
189
  FaceDetectedInTargetPositionEndTimestamp: number | undefined;
190
190
  }
191
191
  /**
192
- * @public
193
192
  * <p>Holds information about the type of face movement and light challenges that need to be
194
193
  * performed.</p>
194
+ * @public
195
195
  */
196
196
  export interface FaceMovementAndLightClientChallenge {
197
197
  /**
198
- * @public
199
198
  * <p>An ID that uniquely identifies a challenge from a client.</p>
199
+ * @public
200
200
  */
201
201
  ChallengeId: string | undefined;
202
202
  /**
203
- * @public
204
203
  * <p>Epoch timestamp indicating start of video recording.</p>
204
+ * @public
205
205
  */
206
206
  VideoStartTimestamp?: number;
207
207
  /**
208
- * @public
209
208
  * <p>Epoch timestamp indicating end of video recording.</p>
209
+ * @public
210
210
  */
211
211
  VideoEndTimestamp?: number;
212
212
  /**
213
- * @public
214
213
  * <p>Contains the bounding box of the initial face position for the user on the device screen.
215
214
  * Also contains an epoch timestamp of when the user was detected in this position. Used for Face
216
215
  * Liveness detection.</p>
216
+ * @public
217
217
  */
218
218
  InitialFace?: InitialFace;
219
219
  /**
220
- * @public
221
220
  * <p>Contains the face position bounding box for the user on the device's screen, set at the
222
221
  * target location constructed for the challenge. Generated using a precise oval location
223
222
  * depending on the provided video </p>
224
223
  * <p>dimensions in the input stream. Contains start and end epoch timestamp of when the user
225
224
  * was detected in this position.</p>
225
+ * @public
226
226
  */
227
227
  TargetFace?: TargetFace;
228
228
  /**
229
- * @public
230
229
  * <p>Contains information regarding SequenceNumber, CurrentColor, PreviousColor, and CurrentColorStartTimestamp for a challenge.</p>
230
+ * @public
231
231
  */
232
232
  ColorDisplayed?: ColorDisplayed;
233
233
  }
234
234
  /**
235
- * @public
236
235
  * <p>Object containing information for Face Liveness challenges performed at the client
237
236
  * side.</p>
237
+ * @public
238
238
  */
239
239
  export type ClientChallenge = ClientChallenge.FaceMovementAndLightChallengeMember | ClientChallenge.$UnknownMember;
240
240
  /**
@@ -242,8 +242,8 @@ export type ClientChallenge = ClientChallenge.FaceMovementAndLightChallengeMembe
242
242
  */
243
243
  export declare namespace ClientChallenge {
244
244
  /**
245
- * @public
246
245
  * <p>Information about a face movement and light challenge type.</p>
246
+ * @public
247
247
  */
248
248
  interface FaceMovementAndLightChallengeMember {
249
249
  FaceMovementAndLightChallenge: FaceMovementAndLightClientChallenge;
@@ -263,47 +263,47 @@ export declare namespace ClientChallenge {
263
263
  const visit: <T>(value: ClientChallenge, visitor: Visitor<T>) => T;
264
264
  }
265
265
  /**
266
- * @public
267
266
  * <p>Any information that the client needs to send for the streaming session. For face movement challenge,
268
267
  * it will contain information like initial face position and target face position.</p>
268
+ * @public
269
269
  */
270
270
  export interface ClientSessionInformationEvent {
271
271
  /**
272
- * @public
273
272
  * <p>Contains information on FaceMovementAndLightChellenge, TargetFace, and ColorDisplayed, for a given Challenge.</p>
273
+ * @public
274
274
  */
275
275
  Challenge: ClientChallenge | undefined;
276
276
  }
277
277
  /**
278
- * @public
279
278
  * <p>A color sequence to be displayed on the user’s screen. </p>
279
+ * @public
280
280
  */
281
281
  export interface ColorSequence {
282
282
  /**
283
- * @public
284
283
  * <p>Represents the colors in a given ColorSequence to be flashed to the end user, with each color represented in RGB values.</p>
284
+ * @public
285
285
  */
286
286
  FreshnessColor: FreshnessColor | undefined;
287
287
  /**
288
- * @public
289
288
  * <p>Duration in milliseconds for which a given color in the color sequence will down-scroll before taking over full screen.</p>
289
+ * @public
290
290
  */
291
291
  DownscrollDuration: number | undefined;
292
292
  /**
293
- * @public
294
293
  * <p>Duration in milliseconds for which a given flat color in the color sequence will be displayed on the full screen.</p>
294
+ * @public
295
295
  */
296
296
  FlatDisplayDuration: number | undefined;
297
297
  }
298
298
  /**
299
- * @public
300
299
  * <p>Contains information regarding if a disconnection event took place
301
300
  * during the Face Liveness session. Disconnection events may indicate processing is complete at the server side.</p>
301
+ * @public
302
302
  */
303
303
  export interface DisconnectionEvent {
304
304
  /**
305
- * @public
306
305
  * <p>The timestamp that a disconnection event took place at.</p>
306
+ * @public
307
307
  */
308
308
  TimestampMillis: number | undefined;
309
309
  }
@@ -319,61 +319,61 @@ export declare const LightChallengeType: {
319
319
  */
320
320
  export type LightChallengeType = (typeof LightChallengeType)[keyof typeof LightChallengeType];
321
321
  /**
322
- * @public
323
322
  * <p>Oval parameters need for oval display to complete oval match challenge.</p>
323
+ * @public
324
324
  */
325
325
  export interface OvalParameters {
326
326
  /**
327
- * @public
328
327
  * <p>Width of the oval</p>
328
+ * @public
329
329
  */
330
330
  Width: number | undefined;
331
331
  /**
332
- * @public
333
332
  * <p>Height of the oval</p>
333
+ * @public
334
334
  */
335
335
  Height: number | undefined;
336
336
  /**
337
- * @public
338
337
  * <p>X-axis co-ordinate of for center of oval</p>
338
+ * @public
339
339
  */
340
340
  CenterX: number | undefined;
341
341
  /**
342
- * @public
343
342
  * <p>Y-axis co-ordinate of for center of oval</p>
343
+ * @public
344
344
  */
345
345
  CenterY: number | undefined;
346
346
  }
347
347
  /**
348
- * @public
349
348
  * <p>Contains information regarding the <code>OvalParameters</code> and
350
349
  * <code>LightChallengeType</code> for a challenge.</p>
350
+ * @public
351
351
  */
352
352
  export interface FaceMovementAndLightServerChallenge {
353
353
  /**
354
- * @public
355
354
  * <p>The parameters needed for an oval to display and to complete oval match challenge.</p>
355
+ * @public
356
356
  */
357
357
  OvalParameters: OvalParameters | undefined;
358
358
  /**
359
- * @public
360
359
  * <p>Information on the type of colored light challenge.</p>
360
+ * @public
361
361
  */
362
362
  LightChallengeType: LightChallengeType | undefined;
363
363
  /**
364
- * @public
365
364
  * <p>Configurations for attributes of the Face Liveness movement and light challenges.</p>
365
+ * @public
366
366
  */
367
367
  ChallengeConfig: ChallengeConfig | undefined;
368
368
  /**
369
- * @public
370
369
  * <p>Used to generate a list of color sequences to be displayed on a user's screen.</p>
370
+ * @public
371
371
  */
372
372
  ColorSequences: ColorSequence[] | undefined;
373
373
  }
374
374
  /**
375
- * @public
376
375
  * <p>Unexpected error during processing of request.</p>
376
+ * @public
377
377
  */
378
378
  export declare class InternalServerException extends __BaseException {
379
379
  readonly name: "InternalServerException";
@@ -386,24 +386,24 @@ export declare class InternalServerException extends __BaseException {
386
386
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
387
387
  }
388
388
  /**
389
- * @public
390
389
  * <p>Contains the video chunk blob.</p>
390
+ * @public
391
391
  */
392
392
  export interface VideoEvent {
393
393
  /**
394
- * @public
395
394
  * <p>The video chunk for a video event.</p>
395
+ * @public
396
396
  */
397
397
  VideoChunk?: Uint8Array;
398
398
  /**
399
- * @public
400
399
  * <p>Milisecond timestamp for a video chunk in a video event.</p>
400
+ * @public
401
401
  */
402
402
  TimestampMillis?: number;
403
403
  }
404
404
  /**
405
- * @public
406
405
  * <p>Contains information regarding video events and client session details for a Face Liveness verification request stream.</p>
406
+ * @public
407
407
  */
408
408
  export type LivenessRequestStream = LivenessRequestStream.ClientSessionInformationEventMember | LivenessRequestStream.VideoEventMember | LivenessRequestStream.$UnknownMember;
409
409
  /**
@@ -411,8 +411,8 @@ export type LivenessRequestStream = LivenessRequestStream.ClientSessionInformati
411
411
  */
412
412
  export declare namespace LivenessRequestStream {
413
413
  /**
414
- * @public
415
414
  * <p>Contains video events for a Face Liveness request stream.</p>
415
+ * @public
416
416
  */
417
417
  interface VideoEventMember {
418
418
  VideoEvent: VideoEvent;
@@ -420,8 +420,8 @@ export declare namespace LivenessRequestStream {
420
420
  $unknown?: never;
421
421
  }
422
422
  /**
423
- * @public
424
423
  * <p>Information event for the client session for a given Face Liveness request stream.</p>
424
+ * @public
425
425
  */
426
426
  interface ClientSessionInformationEventMember {
427
427
  VideoEvent?: never;
@@ -444,8 +444,8 @@ export declare namespace LivenessRequestStream {
444
444
  const visit: <T>(value: LivenessRequestStream, visitor: Visitor<T>) => T;
445
445
  }
446
446
  /**
447
- * @public
448
447
  * <p>Information on the challenge sent by the server.</p>
448
+ * @public
449
449
  */
450
450
  export type ServerChallenge = ServerChallenge.FaceMovementAndLightChallengeMember | ServerChallenge.$UnknownMember;
451
451
  /**
@@ -453,8 +453,8 @@ export type ServerChallenge = ServerChallenge.FaceMovementAndLightChallengeMembe
453
453
  */
454
454
  export declare namespace ServerChallenge {
455
455
  /**
456
- * @public
457
456
  * <p>Paramteters and configuration information for the face movement and light sequence challenges.</p>
457
+ * @public
458
458
  */
459
459
  interface FaceMovementAndLightChallengeMember {
460
460
  FaceMovementAndLightChallenge: FaceMovementAndLightServerChallenge;
@@ -474,30 +474,30 @@ export declare namespace ServerChallenge {
474
474
  const visit: <T>(value: ServerChallenge, visitor: Visitor<T>) => T;
475
475
  }
476
476
  /**
477
- * @public
478
477
  * <p>Information required for the streaming session.</p>
478
+ * @public
479
479
  */
480
480
  export interface SessionInformation {
481
481
  /**
482
- * @public
483
482
  * <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>
483
+ * @public
484
484
  */
485
485
  Challenge: ServerChallenge | undefined;
486
486
  }
487
487
  /**
488
- * @public
489
488
  * <p>Event containing session information for the server.</p>
489
+ * @public
490
490
  */
491
491
  export interface ServerSessionInformationEvent {
492
492
  /**
493
- * @public
494
493
  * <p>Contains the session information sent by the server..</p>
494
+ * @public
495
495
  */
496
496
  SessionInformation: SessionInformation | undefined;
497
497
  }
498
498
  /**
499
- * @public
500
499
  * <p>Occurs when a request would cause a service quota to be exceeded.</p>
500
+ * @public
501
501
  */
502
502
  export declare class ServiceQuotaExceededException extends __BaseException {
503
503
  readonly name: "ServiceQuotaExceededException";
@@ -510,8 +510,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
510
510
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
511
511
  }
512
512
  /**
513
- * @public
514
513
  * <p>Service-wide throttling to recover from an operational event or service is not able to scale.</p>
514
+ * @public
515
515
  */
516
516
  export declare class ServiceUnavailableException extends __BaseException {
517
517
  readonly name: "ServiceUnavailableException";
@@ -524,9 +524,9 @@ export declare class ServiceUnavailableException extends __BaseException {
524
524
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
525
525
  }
526
526
  /**
527
- * @public
528
527
  * <p>A request was denied due to request throttling. Occurs when too many requests were made by a user
529
528
  * (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>
529
+ * @public
530
530
  */
531
531
  export declare class ThrottlingException extends __BaseException {
532
532
  readonly name: "ThrottlingException";
@@ -539,12 +539,12 @@ export declare class ThrottlingException extends __BaseException {
539
539
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
540
540
  }
541
541
  /**
542
- * @public
543
542
  * <p>The input fails to satisfy the constraints specified by the service. Potential reasons
544
543
  * inlcude: video quality or size is invalid, video container format not supported, video does
545
544
  * not have enough information - no person detected in video, request couldn't be parsed or is
546
545
  * invalid, session has expired or is invalid, S3 bucket is invalid/in another AWS region, KMS
547
546
  * Key is invalid.</p>
547
+ * @public
548
548
  */
549
549
  export declare class ValidationException extends __BaseException {
550
550
  readonly name: "ValidationException";
@@ -557,8 +557,8 @@ export declare class ValidationException extends __BaseException {
557
557
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
558
558
  }
559
559
  /**
560
- * @public
561
560
  * <p>Contains information event details and exception information for a Face Liveness verification response stream.</p>
561
+ * @public
562
562
  */
563
563
  export type LivenessResponseStream = LivenessResponseStream.DisconnectionEventMember | LivenessResponseStream.InternalServerExceptionMember | LivenessResponseStream.ServerSessionInformationEventMember | LivenessResponseStream.ServiceQuotaExceededExceptionMember | LivenessResponseStream.ServiceUnavailableExceptionMember | LivenessResponseStream.ThrottlingExceptionMember | LivenessResponseStream.ValidationExceptionMember | LivenessResponseStream.$UnknownMember;
564
564
  /**
@@ -566,8 +566,8 @@ export type LivenessResponseStream = LivenessResponseStream.DisconnectionEventMe
566
566
  */
567
567
  export declare namespace LivenessResponseStream {
568
568
  /**
569
- * @public
570
569
  * <p>Details for a server session information event.</p>
570
+ * @public
571
571
  */
572
572
  interface ServerSessionInformationEventMember {
573
573
  ServerSessionInformationEvent: ServerSessionInformationEvent;
@@ -580,8 +580,8 @@ export declare namespace LivenessResponseStream {
580
580
  $unknown?: never;
581
581
  }
582
582
  /**
583
- * @public
584
583
  * <p>Notification that disconnection event has occurred to a Face Liveness session.</p>
584
+ * @public
585
585
  */
586
586
  interface DisconnectionEventMember {
587
587
  ServerSessionInformationEvent?: never;
@@ -594,8 +594,8 @@ export declare namespace LivenessResponseStream {
594
594
  $unknown?: never;
595
595
  }
596
596
  /**
597
- * @public
598
597
  * <p>Notification that a ValidationException occurred during a Face Liveness session.</p>
598
+ * @public
599
599
  */
600
600
  interface ValidationExceptionMember {
601
601
  ServerSessionInformationEvent?: never;
@@ -608,8 +608,8 @@ export declare namespace LivenessResponseStream {
608
608
  $unknown?: never;
609
609
  }
610
610
  /**
611
- * @public
612
611
  * <p>Notification that an InternalServerException occurred during a Face Liveness session.</p>
612
+ * @public
613
613
  */
614
614
  interface InternalServerExceptionMember {
615
615
  ServerSessionInformationEvent?: never;
@@ -622,8 +622,8 @@ export declare namespace LivenessResponseStream {
622
622
  $unknown?: never;
623
623
  }
624
624
  /**
625
- * @public
626
625
  * <p>Notification that a ThrottlingException occurred during a Face Liveness session.</p>
626
+ * @public
627
627
  */
628
628
  interface ThrottlingExceptionMember {
629
629
  ServerSessionInformationEvent?: never;
@@ -636,8 +636,8 @@ export declare namespace LivenessResponseStream {
636
636
  $unknown?: never;
637
637
  }
638
638
  /**
639
- * @public
640
639
  * <p>Notification that a ServiceQuotaExceededException occurred during a Face Liveness session.</p>
640
+ * @public
641
641
  */
642
642
  interface ServiceQuotaExceededExceptionMember {
643
643
  ServerSessionInformationEvent?: never;
@@ -650,8 +650,8 @@ export declare namespace LivenessResponseStream {
650
650
  $unknown?: never;
651
651
  }
652
652
  /**
653
- * @public
654
653
  * <p>Notification that a ServiceUnavailableException occurred during a Face Liveness session.</p>
654
+ * @public
655
655
  */
656
656
  interface ServiceUnavailableExceptionMember {
657
657
  ServerSessionInformationEvent?: never;
@@ -689,8 +689,8 @@ export declare namespace LivenessResponseStream {
689
689
  const visit: <T>(value: LivenessResponseStream, visitor: Visitor<T>) => T;
690
690
  }
691
691
  /**
692
- * @public
693
692
  * <p>Occurs when the given <code>sessionId</code> is not found.</p>
693
+ * @public
694
694
  */
695
695
  export declare class SessionNotFoundException extends __BaseException {
696
696
  readonly name: "SessionNotFoundException";
@@ -707,31 +707,31 @@ export declare class SessionNotFoundException extends __BaseException {
707
707
  */
708
708
  export interface StartFaceLivenessSessionRequest {
709
709
  /**
710
- * @public
711
710
  * <p>A unique 128-bit UUID. Used to uniquely identify the session and also acta as an
712
711
  * idempotency token for all operations associated with the session.</p>
712
+ * @public
713
713
  */
714
714
  SessionId: string | undefined;
715
715
  /**
716
- * @public
717
716
  * <p>The width of the video object included in a request to start a Face Liveness
718
717
  * session.</p>
718
+ * @public
719
719
  */
720
720
  VideoWidth: string | undefined;
721
721
  /**
722
- * @public
723
722
  * <p>The height of the video object included in a request to start a Face Liveness
724
723
  * session.</p>
724
+ * @public
725
725
  */
726
726
  VideoHeight: string | undefined;
727
727
  /**
728
- * @public
729
728
  * <p>String containing comma separated list of challenge versions supported by client.</p>
729
+ * @public
730
730
  */
731
731
  ChallengeVersions: string | undefined;
732
732
  /**
733
- * @public
734
733
  * <p>Information regarding the request stream for a Face Liveness session.</p>
734
+ * @public
735
735
  */
736
736
  LivenessRequestStream?: AsyncIterable<LivenessRequestStream>;
737
737
  }
@@ -740,13 +740,13 @@ export interface StartFaceLivenessSessionRequest {
740
740
  */
741
741
  export interface StartFaceLivenessSessionResponse {
742
742
  /**
743
- * @public
744
743
  * <p>The ID that identifies a Face Liveness session.</p>
744
+ * @public
745
745
  */
746
746
  SessionId: string | undefined;
747
747
  /**
748
- * @public
749
748
  * <p>Information regarding the response stream for a Face Liveness session.</p>
749
+ * @public
750
750
  */
751
751
  LivenessResponseStream?: AsyncIterable<LivenessResponseStream>;
752
752
  }
@@ -21,6 +21,15 @@ declare const StartFaceLivenessSessionCommand_base: {
21
21
  StartFaceLivenessSessionCommandInput,
22
22
  StartFaceLivenessSessionCommandOutput
23
23
  >;
24
+ new (
25
+ __0_0: StartFaceLivenessSessionCommandInput
26
+ ): import("@smithy/smithy-client").CommandImpl<
27
+ StartFaceLivenessSessionCommandInput,
28
+ StartFaceLivenessSessionCommandOutput,
29
+ RekognitionStreamingClientResolvedConfig,
30
+ StartFaceLivenessSessionCommandInput,
31
+ StartFaceLivenessSessionCommandOutput
32
+ >;
24
33
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
25
34
  };
26
35
  export declare class StartFaceLivenessSessionCommand extends StartFaceLivenessSessionCommand_base {}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rekognitionstreaming",
3
3
  "description": "AWS SDK for JavaScript Rekognitionstreaming Client for Node.js, Browser and React Native",
4
- "version": "3.534.0",
4
+ "version": "3.535.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-rekognitionstreaming",
@@ -20,53 +20,53 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.533.0",
24
- "@aws-sdk/core": "3.533.0",
25
- "@aws-sdk/credential-provider-node": "3.533.0",
26
- "@aws-sdk/eventstream-handler-node": "3.533.0",
27
- "@aws-sdk/middleware-eventstream": "3.533.0",
28
- "@aws-sdk/middleware-host-header": "3.533.0",
29
- "@aws-sdk/middleware-logger": "3.533.0",
30
- "@aws-sdk/middleware-recursion-detection": "3.533.0",
31
- "@aws-sdk/middleware-signing": "3.534.0",
32
- "@aws-sdk/middleware-user-agent": "3.533.0",
33
- "@aws-sdk/middleware-websocket": "3.534.0",
34
- "@aws-sdk/region-config-resolver": "3.533.0",
35
- "@aws-sdk/types": "3.533.0",
36
- "@aws-sdk/util-endpoints": "3.533.0",
37
- "@aws-sdk/util-user-agent-browser": "3.533.0",
38
- "@aws-sdk/util-user-agent-node": "3.533.0",
39
- "@smithy/config-resolver": "^2.1.5",
40
- "@smithy/core": "^1.3.8",
41
- "@smithy/eventstream-serde-browser": "^2.1.4",
42
- "@smithy/eventstream-serde-config-resolver": "^2.1.4",
43
- "@smithy/eventstream-serde-node": "^2.1.4",
44
- "@smithy/fetch-http-handler": "^2.4.5",
45
- "@smithy/hash-node": "^2.1.4",
46
- "@smithy/invalid-dependency": "^2.1.4",
47
- "@smithy/middleware-content-length": "^2.1.4",
48
- "@smithy/middleware-endpoint": "^2.4.6",
49
- "@smithy/middleware-retry": "^2.1.7",
50
- "@smithy/middleware-serde": "^2.2.1",
51
- "@smithy/middleware-stack": "^2.1.4",
52
- "@smithy/node-config-provider": "^2.2.5",
53
- "@smithy/node-http-handler": "^2.4.3",
54
- "@smithy/protocol-http": "^3.2.2",
55
- "@smithy/smithy-client": "^2.4.5",
56
- "@smithy/types": "^2.11.0",
57
- "@smithy/url-parser": "^2.1.4",
58
- "@smithy/util-base64": "^2.2.1",
59
- "@smithy/util-body-length-browser": "^2.1.1",
60
- "@smithy/util-body-length-node": "^2.2.2",
61
- "@smithy/util-defaults-mode-browser": "^2.1.7",
62
- "@smithy/util-defaults-mode-node": "^2.2.7",
63
- "@smithy/util-endpoints": "^1.1.5",
64
- "@smithy/util-retry": "^2.1.4",
65
- "@smithy/util-utf8": "^2.2.0",
66
- "tslib": "^2.5.0"
23
+ "@aws-sdk/client-sts": "3.535.0",
24
+ "@aws-sdk/core": "3.535.0",
25
+ "@aws-sdk/credential-provider-node": "3.535.0",
26
+ "@aws-sdk/eventstream-handler-node": "3.535.0",
27
+ "@aws-sdk/middleware-eventstream": "3.535.0",
28
+ "@aws-sdk/middleware-host-header": "3.535.0",
29
+ "@aws-sdk/middleware-logger": "3.535.0",
30
+ "@aws-sdk/middleware-recursion-detection": "3.535.0",
31
+ "@aws-sdk/middleware-signing": "3.535.0",
32
+ "@aws-sdk/middleware-user-agent": "3.535.0",
33
+ "@aws-sdk/middleware-websocket": "3.535.0",
34
+ "@aws-sdk/region-config-resolver": "3.535.0",
35
+ "@aws-sdk/types": "3.535.0",
36
+ "@aws-sdk/util-endpoints": "3.535.0",
37
+ "@aws-sdk/util-user-agent-browser": "3.535.0",
38
+ "@aws-sdk/util-user-agent-node": "3.535.0",
39
+ "@smithy/config-resolver": "^2.2.0",
40
+ "@smithy/core": "^1.4.0",
41
+ "@smithy/eventstream-serde-browser": "^2.2.0",
42
+ "@smithy/eventstream-serde-config-resolver": "^2.2.0",
43
+ "@smithy/eventstream-serde-node": "^2.2.0",
44
+ "@smithy/fetch-http-handler": "^2.5.0",
45
+ "@smithy/hash-node": "^2.2.0",
46
+ "@smithy/invalid-dependency": "^2.2.0",
47
+ "@smithy/middleware-content-length": "^2.2.0",
48
+ "@smithy/middleware-endpoint": "^2.5.0",
49
+ "@smithy/middleware-retry": "^2.2.0",
50
+ "@smithy/middleware-serde": "^2.3.0",
51
+ "@smithy/middleware-stack": "^2.2.0",
52
+ "@smithy/node-config-provider": "^2.3.0",
53
+ "@smithy/node-http-handler": "^2.5.0",
54
+ "@smithy/protocol-http": "^3.3.0",
55
+ "@smithy/smithy-client": "^2.5.0",
56
+ "@smithy/types": "^2.12.0",
57
+ "@smithy/url-parser": "^2.2.0",
58
+ "@smithy/util-base64": "^2.3.0",
59
+ "@smithy/util-body-length-browser": "^2.2.0",
60
+ "@smithy/util-body-length-node": "^2.3.0",
61
+ "@smithy/util-defaults-mode-browser": "^2.2.0",
62
+ "@smithy/util-defaults-mode-node": "^2.3.0",
63
+ "@smithy/util-endpoints": "^1.2.0",
64
+ "@smithy/util-retry": "^2.2.0",
65
+ "@smithy/util-utf8": "^2.3.0",
66
+ "tslib": "^2.6.2"
67
67
  },
68
68
  "devDependencies": {
69
- "@smithy/service-client-documentation-generator": "^2.1.1",
69
+ "@smithy/service-client-documentation-generator": "^2.2.0",
70
70
  "@tsconfig/node14": "1.0.3",
71
71
  "@types/node": "^14.14.31",
72
72
  "concurrently": "7.0.0",