@aws-sdk/client-rekognition 3.309.0 → 3.310.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.
- package/README.md +16 -0
- package/dist-cjs/Rekognition.js +30 -0
- package/dist-cjs/commands/CreateFaceLivenessSessionCommand.js +45 -0
- package/dist-cjs/commands/GetFaceLivenessSessionResultsCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +36 -2
- package/dist-cjs/models/models_1.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +193 -3
- package/dist-es/Rekognition.js +30 -0
- package/dist-es/commands/CreateFaceLivenessSessionCommand.js +41 -0
- package/dist-es/commands/GetFaceLivenessSessionResultsCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +31 -0
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +187 -1
- package/dist-types/Rekognition.d.ts +51 -10
- package/dist-types/RekognitionClient.d.ts +4 -2
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +1 -0
- package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +94 -0
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +17 -7
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +1 -0
- package/dist-types/commands/DetectLabelsCommand.d.ts +2 -3
- package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +88 -0
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +1 -0
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +1 -0
- package/dist-types/commands/StopProjectVersionCommand.d.ts +1 -0
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +241 -106
- package/dist-types/models/models_1.d.ts +56 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/Rekognition.d.ts +34 -0
- package/dist-types/ts3.4/RekognitionClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateFaceLivenessSessionCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/GetFaceLivenessSessionResultsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/UpdateStreamProcessorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +59 -17
- package/dist-types/ts3.4/models/models_1.d.ts +17 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +36 -36
|
@@ -122,6 +122,85 @@ export interface AudioMetadata {
|
|
|
122
122
|
*/
|
|
123
123
|
NumberOfChannels?: number;
|
|
124
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
128
|
+
* personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
|
|
129
|
+
* (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
|
|
130
|
+
* that the upper-left corner of the image is the origin (0,0). </p>
|
|
131
|
+
* <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall
|
|
132
|
+
* image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of
|
|
133
|
+
* the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700)
|
|
134
|
+
* and a <code>top</code> value of 0.25 (50/200).</p>
|
|
135
|
+
* <p>The <code>width</code> and <code>height</code> values represent the dimensions of the
|
|
136
|
+
* bounding box as a ratio of the overall image dimension. For example, if the input image is
|
|
137
|
+
* 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p>
|
|
138
|
+
* <note>
|
|
139
|
+
* <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is
|
|
140
|
+
* able to detect a face that is at the image edge and is only partially visible, the service
|
|
141
|
+
* can return coordinates that are outside the image bounds and, depending on the image edge,
|
|
142
|
+
* you might get negative values or values greater than 1 for the <code>left</code> or
|
|
143
|
+
* <code>top</code> values. </p>
|
|
144
|
+
* </note>
|
|
145
|
+
*/
|
|
146
|
+
export interface BoundingBox {
|
|
147
|
+
/**
|
|
148
|
+
* <p>Width of the bounding box as a ratio of the overall image width.</p>
|
|
149
|
+
*/
|
|
150
|
+
Width?: number;
|
|
151
|
+
/**
|
|
152
|
+
* <p>Height of the bounding box as a ratio of the overall image height.</p>
|
|
153
|
+
*/
|
|
154
|
+
Height?: number;
|
|
155
|
+
/**
|
|
156
|
+
* <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
|
|
157
|
+
*/
|
|
158
|
+
Left?: number;
|
|
159
|
+
/**
|
|
160
|
+
* <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
|
|
161
|
+
*/
|
|
162
|
+
Top?: number;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* <p>An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.</p>
|
|
167
|
+
*/
|
|
168
|
+
export interface AuditImage {
|
|
169
|
+
/**
|
|
170
|
+
* <p>The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.</p>
|
|
171
|
+
*/
|
|
172
|
+
Bytes?: Uint8Array;
|
|
173
|
+
/**
|
|
174
|
+
* <p>Provides the S3 bucket name and object name.</p>
|
|
175
|
+
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
176
|
+
* Amazon Rekognition operations.</p>
|
|
177
|
+
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
178
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
179
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
180
|
+
*/
|
|
181
|
+
S3Object?: S3Object;
|
|
182
|
+
/**
|
|
183
|
+
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
184
|
+
* personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
|
|
185
|
+
* (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
|
|
186
|
+
* that the upper-left corner of the image is the origin (0,0). </p>
|
|
187
|
+
* <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall
|
|
188
|
+
* image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of
|
|
189
|
+
* the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700)
|
|
190
|
+
* and a <code>top</code> value of 0.25 (50/200).</p>
|
|
191
|
+
* <p>The <code>width</code> and <code>height</code> values represent the dimensions of the
|
|
192
|
+
* bounding box as a ratio of the overall image dimension. For example, if the input image is
|
|
193
|
+
* 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p>
|
|
194
|
+
* <note>
|
|
195
|
+
* <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is
|
|
196
|
+
* able to detect a face that is at the image edge and is only partially visible, the service
|
|
197
|
+
* can return coordinates that are outside the image bounds and, depending on the image edge,
|
|
198
|
+
* you might get negative values or values greater than 1 for the <code>left</code> or
|
|
199
|
+
* <code>top</code> values. </p>
|
|
200
|
+
* </note>
|
|
201
|
+
*/
|
|
202
|
+
BoundingBox?: BoundingBox;
|
|
203
|
+
}
|
|
125
204
|
/**
|
|
126
205
|
* @public
|
|
127
206
|
* <p>Indicates whether or not the face has a beard, and the confidence level in the
|
|
@@ -182,45 +261,6 @@ export declare const BodyPart: {
|
|
|
182
261
|
* @public
|
|
183
262
|
*/
|
|
184
263
|
export type BodyPart = (typeof BodyPart)[keyof typeof BodyPart];
|
|
185
|
-
/**
|
|
186
|
-
* @public
|
|
187
|
-
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
188
|
-
* personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
|
|
189
|
-
* (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
|
|
190
|
-
* that the upper-left corner of the image is the origin (0,0). </p>
|
|
191
|
-
* <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall
|
|
192
|
-
* image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of
|
|
193
|
-
* the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700)
|
|
194
|
-
* and a <code>top</code> value of 0.25 (50/200).</p>
|
|
195
|
-
* <p>The <code>width</code> and <code>height</code> values represent the dimensions of the
|
|
196
|
-
* bounding box as a ratio of the overall image dimension. For example, if the input image is
|
|
197
|
-
* 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p>
|
|
198
|
-
* <note>
|
|
199
|
-
* <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is
|
|
200
|
-
* able to detect a face that is at the image edge and is only partially visible, the service
|
|
201
|
-
* can return coordinates that are outside the image bounds and, depending on the image edge,
|
|
202
|
-
* you might get negative values or values greater than 1 for the <code>left</code> or
|
|
203
|
-
* <code>top</code> values. </p>
|
|
204
|
-
* </note>
|
|
205
|
-
*/
|
|
206
|
-
export interface BoundingBox {
|
|
207
|
-
/**
|
|
208
|
-
* <p>Width of the bounding box as a ratio of the overall image width.</p>
|
|
209
|
-
*/
|
|
210
|
-
Width?: number;
|
|
211
|
-
/**
|
|
212
|
-
* <p>Height of the bounding box as a ratio of the overall image height.</p>
|
|
213
|
-
*/
|
|
214
|
-
Height?: number;
|
|
215
|
-
/**
|
|
216
|
-
* <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
|
|
217
|
-
*/
|
|
218
|
-
Left?: number;
|
|
219
|
-
/**
|
|
220
|
-
* <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
|
|
221
|
-
*/
|
|
222
|
-
Top?: number;
|
|
223
|
-
}
|
|
224
264
|
/**
|
|
225
265
|
* @public
|
|
226
266
|
* <p>Information about an item of Personal Protective Equipment covering a corresponding body part. For more
|
|
@@ -868,18 +908,17 @@ export type QualityFilter = (typeof QualityFilter)[keyof typeof QualityFilter];
|
|
|
868
908
|
* base64-encoded.</p>
|
|
869
909
|
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
870
910
|
* Amazon Rekognition operations.</p>
|
|
871
|
-
* <p>If you use the
|
|
872
|
-
*
|
|
873
|
-
*
|
|
874
|
-
* property is not supported. You must first upload the image to an Amazon S3 bucket and then
|
|
875
|
-
* call the operation using the S3Object property.</p>
|
|
911
|
+
* <p>If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the
|
|
912
|
+
* Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and
|
|
913
|
+
* then call the operation using the S3Object property.</p>
|
|
876
914
|
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
877
915
|
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
878
916
|
* Amazon Rekognition Developer Guide. </p>
|
|
879
917
|
*/
|
|
880
918
|
export interface Image {
|
|
881
919
|
/**
|
|
882
|
-
* <p>Blob of image bytes up to 5 MBs
|
|
920
|
+
* <p>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to
|
|
921
|
+
* <code>DetectCustomLabels</code> is 4MB. </p>
|
|
883
922
|
*/
|
|
884
923
|
Bytes?: Uint8Array;
|
|
885
924
|
/**
|
|
@@ -1523,6 +1562,75 @@ export interface CreateDatasetResponse {
|
|
|
1523
1562
|
*/
|
|
1524
1563
|
DatasetArn?: string;
|
|
1525
1564
|
}
|
|
1565
|
+
/**
|
|
1566
|
+
* @public
|
|
1567
|
+
* <p>Contains settings that specify the location of an Amazon S3 bucket used
|
|
1568
|
+
* to store the output of a Face Liveness session. Note that the S3 bucket must be located
|
|
1569
|
+
* in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are
|
|
1570
|
+
* auto-generated by the Face Liveness system. </p>
|
|
1571
|
+
*/
|
|
1572
|
+
export interface LivenessOutputConfig {
|
|
1573
|
+
/**
|
|
1574
|
+
* <p>The path to an AWS Amazon S3 bucket used to store Face Liveness session results.</p>
|
|
1575
|
+
*/
|
|
1576
|
+
S3Bucket: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The prefix appended to the output files for the Face Liveness session results.</p>
|
|
1579
|
+
*/
|
|
1580
|
+
S3KeyPrefix?: string;
|
|
1581
|
+
}
|
|
1582
|
+
/**
|
|
1583
|
+
* @public
|
|
1584
|
+
* <p>A session settings object. It contains settings for the operation
|
|
1585
|
+
* to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.</p>
|
|
1586
|
+
*/
|
|
1587
|
+
export interface CreateFaceLivenessSessionRequestSettings {
|
|
1588
|
+
/**
|
|
1589
|
+
* <p>Can specify the location of an Amazon S3 bucket, where reference and audit images will be
|
|
1590
|
+
* stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same
|
|
1591
|
+
* region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by
|
|
1592
|
+
* the Face Liveness system.</p>
|
|
1593
|
+
*/
|
|
1594
|
+
OutputConfig?: LivenessOutputConfig;
|
|
1595
|
+
/**
|
|
1596
|
+
* <p>Number of audit images to be returned back. Takes an integer between 0-4. Any integer less
|
|
1597
|
+
* than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it
|
|
1598
|
+
* is set to 0. The limit is best effort and is based on the actual duration of the
|
|
1599
|
+
* selfie-video.</p>
|
|
1600
|
+
*/
|
|
1601
|
+
AuditImagesLimit?: number;
|
|
1602
|
+
}
|
|
1603
|
+
/**
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1606
|
+
export interface CreateFaceLivenessSessionRequest {
|
|
1607
|
+
/**
|
|
1608
|
+
* <p> The identifier for your AWS Key Management Service key (AWS KMS key).
|
|
1609
|
+
* Used to encrypt audit images and reference images.</p>
|
|
1610
|
+
*/
|
|
1611
|
+
KmsKeyId?: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* <p>A session settings object. It contains settings for the operation to be performed. For
|
|
1614
|
+
* Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>
|
|
1615
|
+
*/
|
|
1616
|
+
Settings?: CreateFaceLivenessSessionRequestSettings;
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>Idempotent token is used to recognize the Face Liveness request. If the same token is used
|
|
1619
|
+
* with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned.
|
|
1620
|
+
* This token is employed to avoid unintentionally creating the same session multiple
|
|
1621
|
+
* times.</p>
|
|
1622
|
+
*/
|
|
1623
|
+
ClientRequestToken?: string;
|
|
1624
|
+
}
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
export interface CreateFaceLivenessSessionResponse {
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>A unique 128-bit UUID identifying a Face Liveness session.</p>
|
|
1631
|
+
*/
|
|
1632
|
+
SessionId: string | undefined;
|
|
1633
|
+
}
|
|
1526
1634
|
/**
|
|
1527
1635
|
* @public
|
|
1528
1636
|
*/
|
|
@@ -2799,11 +2907,9 @@ export interface DetectCustomLabelsRequest {
|
|
|
2799
2907
|
* base64-encoded.</p>
|
|
2800
2908
|
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
2801
2909
|
* Amazon Rekognition operations.</p>
|
|
2802
|
-
* <p>If you use the
|
|
2803
|
-
*
|
|
2804
|
-
*
|
|
2805
|
-
* property is not supported. You must first upload the image to an Amazon S3 bucket and then
|
|
2806
|
-
* call the operation using the S3Object property.</p>
|
|
2910
|
+
* <p>If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the
|
|
2911
|
+
* Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and
|
|
2912
|
+
* then call the operation using the S3Object property.</p>
|
|
2807
2913
|
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
2808
2914
|
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
2809
2915
|
* Amazon Rekognition Developer Guide. </p>
|
|
@@ -2937,8 +3043,8 @@ export type DetectLabelsFeatureName = (typeof DetectLabelsFeatureName)[keyof typ
|
|
|
2937
3043
|
/**
|
|
2938
3044
|
* @public
|
|
2939
3045
|
* <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
|
|
2940
|
-
* exclusive, or a combination of both and can be applied to individual
|
|
2941
|
-
*
|
|
3046
|
+
* exclusive, or a combination of both and can be applied to individual labels or entire label categories.
|
|
3047
|
+
* To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
|
|
2942
3048
|
*/
|
|
2943
3049
|
export interface GeneralLabelsSettings {
|
|
2944
3050
|
/**
|
|
@@ -3020,7 +3126,7 @@ export interface DetectLabelsRequest {
|
|
|
3020
3126
|
* <p>A list of the filters to be applied to returned detected labels and image properties. Specified
|
|
3021
3127
|
* filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual
|
|
3022
3128
|
* labels or label categories. The exact label names or label categories must be supplied. For
|
|
3023
|
-
* a full list of labels and label categories, see
|
|
3129
|
+
* a full list of labels and label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting labels</a>.</p>
|
|
3024
3130
|
*/
|
|
3025
3131
|
Settings?: DetectLabelsSettings;
|
|
3026
3132
|
}
|
|
@@ -3990,6 +4096,82 @@ export interface GetFaceDetectionResponse {
|
|
|
3990
4096
|
*/
|
|
3991
4097
|
Faces?: FaceDetection[];
|
|
3992
4098
|
}
|
|
4099
|
+
/**
|
|
4100
|
+
* @public
|
|
4101
|
+
*/
|
|
4102
|
+
export interface GetFaceLivenessSessionResultsRequest {
|
|
4103
|
+
/**
|
|
4104
|
+
* <p>A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an
|
|
4105
|
+
* idempotency token for all operations associated with the session.</p>
|
|
4106
|
+
*/
|
|
4107
|
+
SessionId: string | undefined;
|
|
4108
|
+
}
|
|
4109
|
+
/**
|
|
4110
|
+
* @public
|
|
4111
|
+
* @enum
|
|
4112
|
+
*/
|
|
4113
|
+
export declare const LivenessSessionStatus: {
|
|
4114
|
+
readonly CREATED: "CREATED";
|
|
4115
|
+
readonly FAILED: "FAILED";
|
|
4116
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
4117
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
4118
|
+
};
|
|
4119
|
+
/**
|
|
4120
|
+
* @public
|
|
4121
|
+
*/
|
|
4122
|
+
export type LivenessSessionStatus = (typeof LivenessSessionStatus)[keyof typeof LivenessSessionStatus];
|
|
4123
|
+
/**
|
|
4124
|
+
* @public
|
|
4125
|
+
*/
|
|
4126
|
+
export interface GetFaceLivenessSessionResultsResponse {
|
|
4127
|
+
/**
|
|
4128
|
+
* <p>The sessionId for which this request was called.</p>
|
|
4129
|
+
*/
|
|
4130
|
+
SessionId: string | undefined;
|
|
4131
|
+
/**
|
|
4132
|
+
* <p>Represents a status corresponding to the state of the session. Possible statuses are:
|
|
4133
|
+
* CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.</p>
|
|
4134
|
+
*/
|
|
4135
|
+
Status: LivenessSessionStatus | string | undefined;
|
|
4136
|
+
/**
|
|
4137
|
+
* <p>Probabalistic confidence score for if the person in the given video was live, represented as a
|
|
4138
|
+
* float value between 0 to 100.</p>
|
|
4139
|
+
*/
|
|
4140
|
+
Confidence?: number;
|
|
4141
|
+
/**
|
|
4142
|
+
* <p>A high-quality image from the Face Liveness video that can be used for face comparison or
|
|
4143
|
+
* search. It includes a bounding box of the face and the Base64-encoded bytes that return an
|
|
4144
|
+
* image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image
|
|
4145
|
+
* will be uploaded to an S3Object specified in the output configuration. In case the reference
|
|
4146
|
+
* image is not returned, it's recommended to retry the Liveness check.</p>
|
|
4147
|
+
*/
|
|
4148
|
+
ReferenceImage?: AuditImage;
|
|
4149
|
+
/**
|
|
4150
|
+
* <p>A set of images from the Face Liveness video that can be used for audit purposes. It
|
|
4151
|
+
* includes a bounding box of the face and the Base64-encoded bytes that return an image. If the
|
|
4152
|
+
* CreateFaceLivenessSession request included an OutputConfig argument, the image will be
|
|
4153
|
+
* uploaded to an S3Object specified in the output configuration.</p>
|
|
4154
|
+
*/
|
|
4155
|
+
AuditImages?: AuditImage[];
|
|
4156
|
+
}
|
|
4157
|
+
/**
|
|
4158
|
+
* @public
|
|
4159
|
+
* <p>Occurs when a given sessionId is not found.</p>
|
|
4160
|
+
*/
|
|
4161
|
+
export declare class SessionNotFoundException extends __BaseException {
|
|
4162
|
+
readonly name: "SessionNotFoundException";
|
|
4163
|
+
readonly $fault: "client";
|
|
4164
|
+
Message?: string;
|
|
4165
|
+
Code?: string;
|
|
4166
|
+
/**
|
|
4167
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
4168
|
+
*/
|
|
4169
|
+
Logref?: string;
|
|
4170
|
+
/**
|
|
4171
|
+
* @internal
|
|
4172
|
+
*/
|
|
4173
|
+
constructor(opts: __ExceptionOptionType<SessionNotFoundException, __BaseException>);
|
|
4174
|
+
}
|
|
3993
4175
|
/**
|
|
3994
4176
|
* @public
|
|
3995
4177
|
*/
|
|
@@ -4789,8 +4971,8 @@ export type LabelDetectionFeatureName = (typeof LabelDetectionFeatureName)[keyof
|
|
|
4789
4971
|
export interface LabelDetectionSettings {
|
|
4790
4972
|
/**
|
|
4791
4973
|
* <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
|
|
4792
|
-
* exclusive, or a combination of both and can be applied to individual
|
|
4793
|
-
*
|
|
4974
|
+
* exclusive, or a combination of both and can be applied to individual labels or entire label categories.
|
|
4975
|
+
* To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
|
|
4794
4976
|
*/
|
|
4795
4977
|
GeneralLabels?: GeneralLabelsSettings;
|
|
4796
4978
|
}
|
|
@@ -5983,57 +6165,10 @@ export declare const StreamProcessorParameterToDelete: {
|
|
|
5983
6165
|
*/
|
|
5984
6166
|
export type StreamProcessorParameterToDelete = (typeof StreamProcessorParameterToDelete)[keyof typeof StreamProcessorParameterToDelete];
|
|
5985
6167
|
/**
|
|
5986
|
-
* @
|
|
5987
|
-
* <p>
|
|
5988
|
-
* The stream processor settings that you want to update. <code>ConnectedHome</code> settings can be updated to detect different labels with a different minimum confidence.
|
|
5989
|
-
* </p>
|
|
5990
|
-
*/
|
|
5991
|
-
export interface StreamProcessorSettingsForUpdate {
|
|
5992
|
-
/**
|
|
5993
|
-
* <p>
|
|
5994
|
-
* The label detection settings you want to use for your stream processor.
|
|
5995
|
-
* </p>
|
|
5996
|
-
*/
|
|
5997
|
-
ConnectedHomeForUpdate?: ConnectedHomeSettingsForUpdate;
|
|
5998
|
-
}
|
|
5999
|
-
/**
|
|
6000
|
-
* @public
|
|
6168
|
+
* @internal
|
|
6001
6169
|
*/
|
|
6002
|
-
export
|
|
6003
|
-
/**
|
|
6004
|
-
* <p>
|
|
6005
|
-
* Name of the stream processor that you want to update.
|
|
6006
|
-
* </p>
|
|
6007
|
-
*/
|
|
6008
|
-
Name: string | undefined;
|
|
6009
|
-
/**
|
|
6010
|
-
* <p>
|
|
6011
|
-
* The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.
|
|
6012
|
-
* </p>
|
|
6013
|
-
*/
|
|
6014
|
-
SettingsForUpdate?: StreamProcessorSettingsForUpdate;
|
|
6015
|
-
/**
|
|
6016
|
-
* <p>
|
|
6017
|
-
* Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
|
|
6018
|
-
* </p>
|
|
6019
|
-
*/
|
|
6020
|
-
RegionsOfInterestForUpdate?: RegionOfInterest[];
|
|
6021
|
-
/**
|
|
6022
|
-
* <p>
|
|
6023
|
-
* Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
|
|
6024
|
-
* Note that if you opt out at the account level this setting is ignored on individual streams.
|
|
6025
|
-
* </p>
|
|
6026
|
-
*/
|
|
6027
|
-
DataSharingPreferenceForUpdate?: StreamProcessorDataSharingPreference;
|
|
6028
|
-
/**
|
|
6029
|
-
* <p>
|
|
6030
|
-
* A list of parameters you want to delete from the stream processor.
|
|
6031
|
-
* </p>
|
|
6032
|
-
*/
|
|
6033
|
-
ParametersToDelete?: (StreamProcessorParameterToDelete | string)[];
|
|
6034
|
-
}
|
|
6170
|
+
export declare const AuditImageFilterSensitiveLog: (obj: AuditImage) => any;
|
|
6035
6171
|
/**
|
|
6036
|
-
* @
|
|
6172
|
+
* @internal
|
|
6037
6173
|
*/
|
|
6038
|
-
export
|
|
6039
|
-
}
|
|
6174
|
+
export declare const GetFaceLivenessSessionResultsResponseFilterSensitiveLog: (obj: GetFaceLivenessSessionResultsResponse) => any;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { ConnectedHomeSettingsForUpdate, RegionOfInterest, StreamProcessorDataSharingPreference, StreamProcessorParameterToDelete } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
* <p>
|
|
5
|
+
* The stream processor settings that you want to update. <code>ConnectedHome</code> settings can be updated to detect different labels with a different minimum confidence.
|
|
6
|
+
* </p>
|
|
7
|
+
*/
|
|
8
|
+
export interface StreamProcessorSettingsForUpdate {
|
|
9
|
+
/**
|
|
10
|
+
* <p>
|
|
11
|
+
* The label detection settings you want to use for your stream processor.
|
|
12
|
+
* </p>
|
|
13
|
+
*/
|
|
14
|
+
ConnectedHomeForUpdate?: ConnectedHomeSettingsForUpdate;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface UpdateStreamProcessorRequest {
|
|
20
|
+
/**
|
|
21
|
+
* <p>
|
|
22
|
+
* Name of the stream processor that you want to update.
|
|
23
|
+
* </p>
|
|
24
|
+
*/
|
|
25
|
+
Name: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>
|
|
28
|
+
* The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.
|
|
29
|
+
* </p>
|
|
30
|
+
*/
|
|
31
|
+
SettingsForUpdate?: StreamProcessorSettingsForUpdate;
|
|
32
|
+
/**
|
|
33
|
+
* <p>
|
|
34
|
+
* Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
|
|
35
|
+
* </p>
|
|
36
|
+
*/
|
|
37
|
+
RegionsOfInterestForUpdate?: RegionOfInterest[];
|
|
38
|
+
/**
|
|
39
|
+
* <p>
|
|
40
|
+
* Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
|
|
41
|
+
* Note that if you opt out at the account level this setting is ignored on individual streams.
|
|
42
|
+
* </p>
|
|
43
|
+
*/
|
|
44
|
+
DataSharingPreferenceForUpdate?: StreamProcessorDataSharingPreference;
|
|
45
|
+
/**
|
|
46
|
+
* <p>
|
|
47
|
+
* A list of parameters you want to delete from the stream processor.
|
|
48
|
+
* </p>
|
|
49
|
+
*/
|
|
50
|
+
ParametersToDelete?: (StreamProcessorParameterToDelete | string)[];
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
export interface UpdateStreamProcessorResponse {
|
|
56
|
+
}
|
|
@@ -4,6 +4,7 @@ import { CompareFacesCommandInput, CompareFacesCommandOutput } from "../commands
|
|
|
4
4
|
import { CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput } from "../commands/CopyProjectVersionCommand";
|
|
5
5
|
import { CreateCollectionCommandInput, CreateCollectionCommandOutput } from "../commands/CreateCollectionCommand";
|
|
6
6
|
import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "../commands/CreateDatasetCommand";
|
|
7
|
+
import { CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput } from "../commands/CreateFaceLivenessSessionCommand";
|
|
7
8
|
import { CreateProjectCommandInput, CreateProjectCommandOutput } from "../commands/CreateProjectCommand";
|
|
8
9
|
import { CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput } from "../commands/CreateProjectVersionCommand";
|
|
9
10
|
import { CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput } from "../commands/CreateStreamProcessorCommand";
|
|
@@ -30,6 +31,7 @@ import { GetCelebrityInfoCommandInput, GetCelebrityInfoCommandOutput } from "../
|
|
|
30
31
|
import { GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput } from "../commands/GetCelebrityRecognitionCommand";
|
|
31
32
|
import { GetContentModerationCommandInput, GetContentModerationCommandOutput } from "../commands/GetContentModerationCommand";
|
|
32
33
|
import { GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput } from "../commands/GetFaceDetectionCommand";
|
|
34
|
+
import { GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput } from "../commands/GetFaceLivenessSessionResultsCommand";
|
|
33
35
|
import { GetFaceSearchCommandInput, GetFaceSearchCommandOutput } from "../commands/GetFaceSearchCommand";
|
|
34
36
|
import { GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput } from "../commands/GetLabelDetectionCommand";
|
|
35
37
|
import { GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput } from "../commands/GetPersonTrackingCommand";
|
|
@@ -79,6 +81,10 @@ export declare const se_CreateCollectionCommand: (input: CreateCollectionCommand
|
|
|
79
81
|
* serializeAws_json1_1CreateDatasetCommand
|
|
80
82
|
*/
|
|
81
83
|
export declare const se_CreateDatasetCommand: (input: CreateDatasetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
84
|
+
/**
|
|
85
|
+
* serializeAws_json1_1CreateFaceLivenessSessionCommand
|
|
86
|
+
*/
|
|
87
|
+
export declare const se_CreateFaceLivenessSessionCommand: (input: CreateFaceLivenessSessionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
82
88
|
/**
|
|
83
89
|
* serializeAws_json1_1CreateProjectCommand
|
|
84
90
|
*/
|
|
@@ -183,6 +189,10 @@ export declare const se_GetContentModerationCommand: (input: GetContentModeratio
|
|
|
183
189
|
* serializeAws_json1_1GetFaceDetectionCommand
|
|
184
190
|
*/
|
|
185
191
|
export declare const se_GetFaceDetectionCommand: (input: GetFaceDetectionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
192
|
+
/**
|
|
193
|
+
* serializeAws_json1_1GetFaceLivenessSessionResultsCommand
|
|
194
|
+
*/
|
|
195
|
+
export declare const se_GetFaceLivenessSessionResultsCommand: (input: GetFaceLivenessSessionResultsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
186
196
|
/**
|
|
187
197
|
* serializeAws_json1_1GetFaceSearchCommand
|
|
188
198
|
*/
|
|
@@ -331,6 +341,10 @@ export declare const de_CreateCollectionCommand: (output: __HttpResponse, contex
|
|
|
331
341
|
* deserializeAws_json1_1CreateDatasetCommand
|
|
332
342
|
*/
|
|
333
343
|
export declare const de_CreateDatasetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateDatasetCommandOutput>;
|
|
344
|
+
/**
|
|
345
|
+
* deserializeAws_json1_1CreateFaceLivenessSessionCommand
|
|
346
|
+
*/
|
|
347
|
+
export declare const de_CreateFaceLivenessSessionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateFaceLivenessSessionCommandOutput>;
|
|
334
348
|
/**
|
|
335
349
|
* deserializeAws_json1_1CreateProjectCommand
|
|
336
350
|
*/
|
|
@@ -435,6 +449,10 @@ export declare const de_GetContentModerationCommand: (output: __HttpResponse, co
|
|
|
435
449
|
* deserializeAws_json1_1GetFaceDetectionCommand
|
|
436
450
|
*/
|
|
437
451
|
export declare const de_GetFaceDetectionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetFaceDetectionCommandOutput>;
|
|
452
|
+
/**
|
|
453
|
+
* deserializeAws_json1_1GetFaceLivenessSessionResultsCommand
|
|
454
|
+
*/
|
|
455
|
+
export declare const de_GetFaceLivenessSessionResultsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetFaceLivenessSessionResultsCommandOutput>;
|
|
438
456
|
/**
|
|
439
457
|
* deserializeAws_json1_1GetFaceSearchCommand
|
|
440
458
|
*/
|
|
@@ -15,6 +15,10 @@ import {
|
|
|
15
15
|
CreateDatasetCommandInput,
|
|
16
16
|
CreateDatasetCommandOutput,
|
|
17
17
|
} from "./commands/CreateDatasetCommand";
|
|
18
|
+
import {
|
|
19
|
+
CreateFaceLivenessSessionCommandInput,
|
|
20
|
+
CreateFaceLivenessSessionCommandOutput,
|
|
21
|
+
} from "./commands/CreateFaceLivenessSessionCommand";
|
|
18
22
|
import {
|
|
19
23
|
CreateProjectCommandInput,
|
|
20
24
|
CreateProjectCommandOutput,
|
|
@@ -119,6 +123,10 @@ import {
|
|
|
119
123
|
GetFaceDetectionCommandInput,
|
|
120
124
|
GetFaceDetectionCommandOutput,
|
|
121
125
|
} from "./commands/GetFaceDetectionCommand";
|
|
126
|
+
import {
|
|
127
|
+
GetFaceLivenessSessionResultsCommandInput,
|
|
128
|
+
GetFaceLivenessSessionResultsCommandOutput,
|
|
129
|
+
} from "./commands/GetFaceLivenessSessionResultsCommand";
|
|
122
130
|
import {
|
|
123
131
|
GetFaceSearchCommandInput,
|
|
124
132
|
GetFaceSearchCommandOutput,
|
|
@@ -305,6 +313,19 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
305
313
|
options: __HttpHandlerOptions,
|
|
306
314
|
cb: (err: any, data?: CreateDatasetCommandOutput) => void
|
|
307
315
|
): void;
|
|
316
|
+
createFaceLivenessSession(
|
|
317
|
+
args: CreateFaceLivenessSessionCommandInput,
|
|
318
|
+
options?: __HttpHandlerOptions
|
|
319
|
+
): Promise<CreateFaceLivenessSessionCommandOutput>;
|
|
320
|
+
createFaceLivenessSession(
|
|
321
|
+
args: CreateFaceLivenessSessionCommandInput,
|
|
322
|
+
cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void
|
|
323
|
+
): void;
|
|
324
|
+
createFaceLivenessSession(
|
|
325
|
+
args: CreateFaceLivenessSessionCommandInput,
|
|
326
|
+
options: __HttpHandlerOptions,
|
|
327
|
+
cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void
|
|
328
|
+
): void;
|
|
308
329
|
createProject(
|
|
309
330
|
args: CreateProjectCommandInput,
|
|
310
331
|
options?: __HttpHandlerOptions
|
|
@@ -643,6 +664,19 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
643
664
|
options: __HttpHandlerOptions,
|
|
644
665
|
cb: (err: any, data?: GetFaceDetectionCommandOutput) => void
|
|
645
666
|
): void;
|
|
667
|
+
getFaceLivenessSessionResults(
|
|
668
|
+
args: GetFaceLivenessSessionResultsCommandInput,
|
|
669
|
+
options?: __HttpHandlerOptions
|
|
670
|
+
): Promise<GetFaceLivenessSessionResultsCommandOutput>;
|
|
671
|
+
getFaceLivenessSessionResults(
|
|
672
|
+
args: GetFaceLivenessSessionResultsCommandInput,
|
|
673
|
+
cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void
|
|
674
|
+
): void;
|
|
675
|
+
getFaceLivenessSessionResults(
|
|
676
|
+
args: GetFaceLivenessSessionResultsCommandInput,
|
|
677
|
+
options: __HttpHandlerOptions,
|
|
678
|
+
cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void
|
|
679
|
+
): void;
|
|
646
680
|
getFaceSearch(
|
|
647
681
|
args: GetFaceSearchCommandInput,
|
|
648
682
|
options?: __HttpHandlerOptions
|
|
@@ -60,6 +60,10 @@ import {
|
|
|
60
60
|
CreateDatasetCommandInput,
|
|
61
61
|
CreateDatasetCommandOutput,
|
|
62
62
|
} from "./commands/CreateDatasetCommand";
|
|
63
|
+
import {
|
|
64
|
+
CreateFaceLivenessSessionCommandInput,
|
|
65
|
+
CreateFaceLivenessSessionCommandOutput,
|
|
66
|
+
} from "./commands/CreateFaceLivenessSessionCommand";
|
|
63
67
|
import {
|
|
64
68
|
CreateProjectCommandInput,
|
|
65
69
|
CreateProjectCommandOutput,
|
|
@@ -164,6 +168,10 @@ import {
|
|
|
164
168
|
GetFaceDetectionCommandInput,
|
|
165
169
|
GetFaceDetectionCommandOutput,
|
|
166
170
|
} from "./commands/GetFaceDetectionCommand";
|
|
171
|
+
import {
|
|
172
|
+
GetFaceLivenessSessionResultsCommandInput,
|
|
173
|
+
GetFaceLivenessSessionResultsCommandOutput,
|
|
174
|
+
} from "./commands/GetFaceLivenessSessionResultsCommand";
|
|
167
175
|
import {
|
|
168
176
|
GetFaceSearchCommandInput,
|
|
169
177
|
GetFaceSearchCommandOutput,
|
|
@@ -306,6 +314,7 @@ export type ServiceInputTypes =
|
|
|
306
314
|
| CopyProjectVersionCommandInput
|
|
307
315
|
| CreateCollectionCommandInput
|
|
308
316
|
| CreateDatasetCommandInput
|
|
317
|
+
| CreateFaceLivenessSessionCommandInput
|
|
309
318
|
| CreateProjectCommandInput
|
|
310
319
|
| CreateProjectVersionCommandInput
|
|
311
320
|
| CreateStreamProcessorCommandInput
|
|
@@ -332,6 +341,7 @@ export type ServiceInputTypes =
|
|
|
332
341
|
| GetCelebrityRecognitionCommandInput
|
|
333
342
|
| GetContentModerationCommandInput
|
|
334
343
|
| GetFaceDetectionCommandInput
|
|
344
|
+
| GetFaceLivenessSessionResultsCommandInput
|
|
335
345
|
| GetFaceSearchCommandInput
|
|
336
346
|
| GetLabelDetectionCommandInput
|
|
337
347
|
| GetPersonTrackingCommandInput
|
|
@@ -370,6 +380,7 @@ export type ServiceOutputTypes =
|
|
|
370
380
|
| CopyProjectVersionCommandOutput
|
|
371
381
|
| CreateCollectionCommandOutput
|
|
372
382
|
| CreateDatasetCommandOutput
|
|
383
|
+
| CreateFaceLivenessSessionCommandOutput
|
|
373
384
|
| CreateProjectCommandOutput
|
|
374
385
|
| CreateProjectVersionCommandOutput
|
|
375
386
|
| CreateStreamProcessorCommandOutput
|
|
@@ -396,6 +407,7 @@ export type ServiceOutputTypes =
|
|
|
396
407
|
| GetCelebrityRecognitionCommandOutput
|
|
397
408
|
| GetContentModerationCommandOutput
|
|
398
409
|
| GetFaceDetectionCommandOutput
|
|
410
|
+
| GetFaceLivenessSessionResultsCommandOutput
|
|
399
411
|
| GetFaceSearchCommandOutput
|
|
400
412
|
| GetLabelDetectionCommandOutput
|
|
401
413
|
| GetPersonTrackingCommandOutput
|