@aws-sdk/client-rekognition 3.385.0 → 3.386.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.
@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
4
  const q = "required", r = "fn", s = "argv", t = "ref";
5
5
  const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
6
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
6
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
7
7
  exports.ruleSet = _data;
@@ -1,4 +1,4 @@
1
1
  const q = "required", r = "fn", s = "argv", t = "ref";
2
2
  const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
3
- const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
3
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
4
4
  export const ruleSet = _data;
@@ -102,9 +102,8 @@ export interface AssociateFacesCommandOutput extends AssociateFacesResponse, __M
102
102
  * <p>You are not authorized to perform the action.</p>
103
103
  *
104
104
  * @throws {@link ConflictException} (client fault)
105
- * <p>
106
- * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
107
- * </p>
105
+ * <p> A User with the same Id already exists within the collection, or the update or deletion
106
+ * of the User caused an inconsistent state. ** </p>
108
107
  *
109
108
  * @throws {@link IdempotentParameterMismatchException} (client fault)
110
109
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
@@ -25,9 +25,9 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
25
25
  * @public
26
26
  * <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
27
27
  * an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
28
- * <p>To create a training dataset for a project, specify <code>train</code> for the value of
28
+ * <p>To create a training dataset for a project, specify <code>TRAIN</code> for the value of
29
29
  * <code>DatasetType</code>. To create the test dataset for a project,
30
- * specify <code>test</code> for the value of <code>DatasetType</code>.
30
+ * specify <code>TEST</code> for the value of <code>DatasetType</code>.
31
31
  * </p>
32
32
  * <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset.
33
33
  * Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> to check the
@@ -25,11 +25,14 @@ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivene
25
25
  * @public
26
26
  * <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>,
27
27
  * which you can use to start streaming Face Liveness video and get the results for a Face
28
- * Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter
29
- * to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images.
30
- * You can use <code>AuditImagesLimit</code> to limit the number of audit images returned. This
31
- * number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on
32
- * the duration of the selfie-video. </p>
28
+ * Liveness session. </p>
29
+ * <p>You can use the <code>OutputConfig</code> option in the Settings parameter to provide an
30
+ * Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3
31
+ * bucket is defined, raw bytes are sent instead. </p>
32
+ * <p>You can use <code>AuditImagesLimit</code> to limit the number of audit images returned
33
+ * when <code>GetFaceLivenessSessionResults</code> is called. This number is between 0 and 4. By
34
+ * default, it is set to 0. The limit is best effort and based on the duration of the
35
+ * selfie-video. </p>
33
36
  * @example
34
37
  * Use a bare-bones client and the command you need to make an API call.
35
38
  * ```javascript
@@ -24,13 +24,13 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
24
24
  /**
25
25
  * @public
26
26
  * <p>Creates a new User within a collection specified by <code>CollectionId</code>. Takes
27
- * <code>UserId</code> as a parameter, which is a user provided ID which should be unique
28
- * within the collection. The provided <code>UserId</code> will alias the system generated
29
- * UUID to make the <code>UserId</code> more user friendly. </p>
27
+ * <code>UserId</code> as a parameter, which is a user provided ID which should be unique
28
+ * within the collection. The provided <code>UserId</code> will alias the system generated UUID
29
+ * to make the <code>UserId</code> more user friendly. </p>
30
30
  * <p>Uses a <code>ClientToken</code>, an idempotency token that ensures a call to
31
- * <code>CreateUser</code> completes only once. If the value is not supplied, the AWS SDK
32
- * generates an idempotency token for the requests. This prevents retries after a network
33
- * error results from making multiple <code>CreateUser</code> calls. </p>
31
+ * <code>CreateUser</code> completes only once. If the value is not supplied, the AWS SDK
32
+ * generates an idempotency token for the requests. This prevents retries after a network error
33
+ * results from making multiple <code>CreateUser</code> calls. </p>
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
36
36
  * ```javascript
@@ -58,9 +58,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
58
58
  * <p>You are not authorized to perform the action.</p>
59
59
  *
60
60
  * @throws {@link ConflictException} (client fault)
61
- * <p>
62
- * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
63
- * </p>
61
+ * <p> A User with the same Id already exists within the collection, or the update or deletion
62
+ * of the User caused an inconsistent state. ** </p>
64
63
  *
65
64
  * @throws {@link IdempotentParameterMismatchException} (client fault)
66
65
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
@@ -55,9 +55,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
55
55
  * <p>You are not authorized to perform the action.</p>
56
56
  *
57
57
  * @throws {@link ConflictException} (client fault)
58
- * <p>
59
- * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
60
- * </p>
58
+ * <p> A User with the same Id already exists within the collection, or the update or deletion
59
+ * of the User caused an inconsistent state. ** </p>
61
60
  *
62
61
  * @throws {@link IdempotentParameterMismatchException} (client fault)
63
62
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
@@ -46,9 +46,11 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
46
46
  * labels or with label categories. You can specify inclusive filters, exclusive filters, or a
47
47
  * combination of inclusive and exclusive filters. For more information on filtering see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html">Detecting
48
48
  * Labels in an Image</a>.</p>
49
- * <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
50
- * labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to
51
- * limit the number of labels returned. The default and upper limit is 1000 labels.</p>
49
+ * <p>When getting labels, you can specify <code>MinConfidence</code> to control the
50
+ * confidence threshold for the labels returned. The default is 55%. You can also add the
51
+ * <code>MaxLabels</code> parameter to limit the number of labels returned. The default and
52
+ * upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a
53
+ * feature type.</p>
52
54
  * <p>
53
55
  * <b>Response Elements</b>
54
56
  * </p>
@@ -95,10 +97,12 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
95
97
  * <p>Dominant Color - An array of the dominant colors in the image. </p>
96
98
  * </li>
97
99
  * <li>
98
- * <p>Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground. </p>
100
+ * <p>Foreground - Information about the sharpness, brightness, and dominant colors of the
101
+ * input image’s foreground. </p>
99
102
  * </li>
100
103
  * <li>
101
- * <p>Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.</p>
104
+ * <p>Background - Information about the sharpness, brightness, and dominant colors of the
105
+ * input image’s background.</p>
102
106
  * </li>
103
107
  * </ul>
104
108
  * <p>The list of returned labels will include at least one label for every detected object,
@@ -77,9 +77,8 @@ export interface DisassociateFacesCommandOutput extends DisassociateFacesRespons
77
77
  * <p>You are not authorized to perform the action.</p>
78
78
  *
79
79
  * @throws {@link ConflictException} (client fault)
80
- * <p>
81
- * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
82
- * </p>
80
+ * <p> A User with the same Id already exists within the collection, or the update or deletion
81
+ * of the User caused an inconsistent state. ** </p>
83
82
  *
84
83
  * @throws {@link IdempotentParameterMismatchException} (client fault)
85
84
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
@@ -36,6 +36,8 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
36
36
  * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
37
37
  * of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token
38
38
  * value returned from the previous call to <code>GetFaceDetection</code>.</p>
39
+ * <p>Note that for the <code>GetFaceDetection</code> operation, the returned values for
40
+ * <code>FaceOccluded</code> and <code>EyeDirection</code> will always be "null".</p>
39
41
  * @example
40
42
  * Use a bare-bones client and the command you need to make an API call.
41
43
  * ```javascript
@@ -27,8 +27,11 @@ export interface GetFaceLivenessSessionResultsCommandOutput extends GetFaceLiven
27
27
  * <code>sessionId</code> as input, which was created using
28
28
  * <code>CreateFaceLivenessSession</code>. Returns the corresponding Face Liveness confidence
29
29
  * score, a reference image that includes a face bounding box, and audit images that also contain
30
- * face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference
31
- * image can optionally be returned.</p>
30
+ * face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. </p>
31
+ * <p>The number of audit images returned by <code>GetFaceLivenessSessionResults</code> is
32
+ * defined by the <code>AuditImagesLimit</code> paramater when calling
33
+ * <code>CreateFaceLivenessSession</code>. Reference images are always returned when
34
+ * possible.</p>
32
35
  * @example
33
36
  * Use a bare-bones client and the command you need to make an API call.
34
37
  * ```javascript
@@ -33,7 +33,7 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
33
33
  * of <code>StartLabelDetection</code>.</p>
34
34
  * <p>
35
35
  * <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by
36
- * the time the text was detected, up to 50 words per frame of video.</p>
36
+ * the time the text was detected, up to 100 words per frame of video.</p>
37
37
  * <p>Each element of the array includes the detected text, the precentage confidence in the acuracy
38
38
  * of the detected text, the time the text was detected, bounding box information for where the text
39
39
  * was located, and unique identifiers for words and their lines.</p>
@@ -29,9 +29,9 @@ export interface SearchUsersByImageCommandOutput extends SearchUsersByImageRespo
29
29
  * ordered by similarity score with the highest similarity first. It also returns a bounding box
30
30
  * for the face found in the input image. </p>
31
31
  * <p>Information about faces detected in the supplied image, but not used for the search, is
32
- * returned in an array of <code>UnsearchedFace</code> objects. If no valid face is detected
33
- * in the image, the response will contain an empty <code>UserMatches</code> list and no
34
- * <code>SearchedFace</code> object. </p>
32
+ * returned in an array of <code>UnsearchedFace</code> objects. If no valid face is detected in
33
+ * the image, the response will contain an empty <code>UserMatches</code> list and no
34
+ * <code>SearchedFace</code> object. </p>
35
35
  * @example
36
36
  * Use a bare-bones client and the command you need to make an API call.
37
37
  * ```javascript
@@ -134,8 +134,8 @@ export interface AssociateFacesRequest {
134
134
  /**
135
135
  * @public
136
136
  * <p>Idempotent token used to identify the request to <code>AssociateFaces</code>. If you use
137
- * the same token with multiple <code>AssociateFaces</code> requests, the same response is returned.
138
- * Use ClientRequestToken to prevent the same request from being processed more than
137
+ * the same token with multiple <code>AssociateFaces</code> requests, the same response is
138
+ * returned. Use ClientRequestToken to prevent the same request from being processed more than
139
139
  * once.</p>
140
140
  */
141
141
  ClientRequestToken?: string;
@@ -155,7 +155,8 @@ export declare const UnsuccessfulFaceAssociationReason: {
155
155
  export type UnsuccessfulFaceAssociationReason = (typeof UnsuccessfulFaceAssociationReason)[keyof typeof UnsuccessfulFaceAssociationReason];
156
156
  /**
157
157
  * @public
158
- * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.</p>
158
+ * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully
159
+ * associated.</p>
159
160
  */
160
161
  export interface UnsuccessfulFaceAssociation {
161
162
  /**
@@ -219,9 +220,8 @@ export interface AssociateFacesResponse {
219
220
  }
220
221
  /**
221
222
  * @public
222
- * <p>
223
- * A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
224
- * </p>
223
+ * <p> A User with the same Id already exists within the collection, or the update or deletion
224
+ * of the User caused an inconsistent state. ** </p>
225
225
  */
226
226
  export declare class ConflictException extends __BaseException {
227
227
  readonly name: "ConflictException";
@@ -472,12 +472,14 @@ export interface BoundingBox {
472
472
  }
473
473
  /**
474
474
  * @public
475
- * <p>An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.</p>
475
+ * <p>An image that is picked from the Face Liveness video and returned for audit trail
476
+ * purposes, returned as Base64-encoded bytes.</p>
476
477
  */
477
478
  export interface AuditImage {
478
479
  /**
479
480
  * @public
480
- * <p>The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.</p>
481
+ * <p>The Base64-encoded bytes representing an image selected from the Face Liveness video and
482
+ * returned for audit purposes.</p>
481
483
  */
482
484
  Bytes?: Uint8Array;
483
485
  /**
@@ -933,7 +935,8 @@ export interface Celebrity {
933
935
  }
934
936
  /**
935
937
  * @public
936
- * <p>Indicates the direction the eyes are gazing in (independent of the head pose) as determined by its pitch and yaw. </p>
938
+ * <p>Indicates the direction the eyes are gazing in (independent of the head pose) as
939
+ * determined by its pitch and yaw. </p>
937
940
  */
938
941
  export interface EyeDirection {
939
942
  /**
@@ -1371,8 +1374,8 @@ export type QualityFilter = (typeof QualityFilter)[keyof typeof QualityFilter];
1371
1374
  export interface Image {
1372
1375
  /**
1373
1376
  * @public
1374
- * <p>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to
1375
- * <code>DetectCustomLabels</code> is 4MB. </p>
1377
+ * <p>Blob of image bytes up to 5 MBs. Note that the maximum image size you can
1378
+ * pass to <code>DetectCustomLabels</code> is 4MB. </p>
1376
1379
  */
1377
1380
  Bytes?: Uint8Array;
1378
1381
  /**
@@ -1688,20 +1691,20 @@ export interface ContentModerationDetection {
1688
1691
  ModerationLabel?: ModerationLabel;
1689
1692
  /**
1690
1693
  * @public
1691
- * <p>The time in milliseconds defining the start of the timeline
1692
- * segment containing a continuously detected moderation label.</p>
1694
+ * <p>The time in milliseconds defining the start of the timeline segment containing a
1695
+ * continuously detected moderation label.</p>
1693
1696
  */
1694
1697
  StartTimestampMillis?: number;
1695
1698
  /**
1696
1699
  * @public
1697
- * <p> The time in milliseconds defining the end of the
1698
- * timeline segment containing a continuously detected moderation label. </p>
1700
+ * <p> The time in milliseconds defining the end of the timeline segment containing a
1701
+ * continuously detected moderation label. </p>
1699
1702
  */
1700
1703
  EndTimestampMillis?: number;
1701
1704
  /**
1702
1705
  * @public
1703
- * <p> The time duration of a segment in milliseconds,
1704
- * I.e. time elapsed from StartTimestampMillis to EndTimestampMillis. </p>
1706
+ * <p> The time duration of a segment in milliseconds, I.e. time elapsed from
1707
+ * StartTimestampMillis to EndTimestampMillis. </p>
1705
1708
  */
1706
1709
  DurationMillis?: number;
1707
1710
  }
@@ -1957,7 +1960,7 @@ export interface CreateDatasetRequest {
1957
1960
  /**
1958
1961
  * @public
1959
1962
  * <p>
1960
- * The type of the dataset. Specify <code>train</code> to create a training dataset. Specify <code>test</code>
1963
+ * The type of the dataset. Specify <code>TRAIN</code> to create a training dataset. Specify <code>TEST</code>
1961
1964
  * to create a test dataset.
1962
1965
  * </p>
1963
1966
  */
@@ -1984,9 +1987,9 @@ export interface CreateDatasetResponse {
1984
1987
  }
1985
1988
  /**
1986
1989
  * @public
1987
- * <p>Contains settings that specify the location of an Amazon S3 bucket used
1988
- * to store the output of a Face Liveness session. Note that the S3 bucket must be located
1989
- * in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are
1990
+ * <p>Contains settings that specify the location of an Amazon S3 bucket used to store the output of
1991
+ * a Face Liveness session. Note that the S3 bucket must be located in the caller's AWS account
1992
+ * and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are
1990
1993
  * auto-generated by the Face Liveness system. </p>
1991
1994
  */
1992
1995
  export interface LivenessOutputConfig {
@@ -2003,8 +2006,8 @@ export interface LivenessOutputConfig {
2003
2006
  }
2004
2007
  /**
2005
2008
  * @public
2006
- * <p>A session settings object. It contains settings for the operation
2007
- * to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.</p>
2009
+ * <p>A session settings object. It contains settings for the operation to be performed. It
2010
+ * accepts arguments for OutputConfig and AuditImagesLimit.</p>
2008
2011
  */
2009
2012
  export interface CreateFaceLivenessSessionRequestSettings {
2010
2013
  /**
@@ -2031,8 +2034,8 @@ export interface CreateFaceLivenessSessionRequestSettings {
2031
2034
  export interface CreateFaceLivenessSessionRequest {
2032
2035
  /**
2033
2036
  * @public
2034
- * <p> The identifier for your AWS Key Management Service key (AWS KMS key).
2035
- * Used to encrypt audit images and reference images.</p>
2037
+ * <p> The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt
2038
+ * audit images and reference images.</p>
2036
2039
  */
2037
2040
  KmsKeyId?: string;
2038
2041
  /**
@@ -2494,9 +2497,8 @@ export interface CreateUserRequest {
2494
2497
  /**
2495
2498
  * @public
2496
2499
  * <p>Idempotent token used to identify the request to <code>CreateUser</code>. If you use the
2497
- * same token with multiple <code>CreateUser</code> requests, the same response is returned.
2498
- * Use ClientRequestToken to prevent the same request from being processed more than
2499
- * once.</p>
2500
+ * same token with multiple <code>CreateUser</code> requests, the same response is returned. Use
2501
+ * ClientRequestToken to prevent the same request from being processed more than once.</p>
2500
2502
  */
2501
2503
  ClientRequestToken?: string;
2502
2504
  }
@@ -2853,7 +2855,8 @@ export declare const UnsuccessfulFaceDeletionReason: {
2853
2855
  export type UnsuccessfulFaceDeletionReason = (typeof UnsuccessfulFaceDeletionReason)[keyof typeof UnsuccessfulFaceDeletionReason];
2854
2856
  /**
2855
2857
  * @public
2856
- * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.</p>
2858
+ * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully
2859
+ * deleted.</p>
2857
2860
  */
2858
2861
  export interface UnsuccessfulFaceDeletion {
2859
2862
  /**
@@ -3038,9 +3041,8 @@ export interface DeleteUserRequest {
3038
3041
  /**
3039
3042
  * @public
3040
3043
  * <p>Idempotent token used to identify the request to <code>DeleteUser</code>. If you use the
3041
- * same token with multiple <code>DeleteUser </code>requests, the same response is returned.
3042
- * Use ClientRequestToken to prevent the same request from being processed more than
3043
- * once.</p>
3044
+ * same token with multiple <code>DeleteUser </code>requests, the same response is returned. Use
3045
+ * ClientRequestToken to prevent the same request from being processed more than once.</p>
3044
3046
  */
3045
3047
  ClientRequestToken?: string;
3046
3048
  }
@@ -3664,6 +3666,9 @@ export interface DetectFacesRequest {
3664
3666
  * response time.</p>
3665
3667
  * <p>If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical "AND"
3666
3668
  * operator to determine which attributes to return (in this case, all attributes). </p>
3669
+ * <p>Note that while the FaceOccluded and EyeDirection attributes are supported when using
3670
+ * <code>DetectFaces</code>, they aren't supported when analyzing videos with
3671
+ * <code>StartFaceDetection</code> and <code>GetFaceDetection</code>.</p>
3667
3672
  */
3668
3673
  Attributes?: (Attribute | string)[];
3669
3674
  }
@@ -3730,8 +3735,8 @@ export type DetectLabelsFeatureName = (typeof DetectLabelsFeatureName)[keyof typ
3730
3735
  /**
3731
3736
  * @public
3732
3737
  * <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
3733
- * exclusive, or a combination of both and can be applied to individual labels or entire label categories.
3734
- * To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
3738
+ * exclusive, or a combination of both and can be applied to individual labels or entire label
3739
+ * categories. To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
3735
3740
  */
3736
3741
  export interface GeneralLabelsSettings {
3737
3742
  /**
@@ -3762,16 +3767,17 @@ export interface GeneralLabelsSettings {
3762
3767
  export interface DetectLabelsImagePropertiesSettings {
3763
3768
  /**
3764
3769
  * @public
3765
- * <p>The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.</p>
3770
+ * <p>The maximum number of dominant colors to return when detecting labels in an image. The
3771
+ * default value is 10.</p>
3766
3772
  */
3767
3773
  MaxDominantColors?: number;
3768
3774
  }
3769
3775
  /**
3770
3776
  * @public
3771
- * <p>Settings for the DetectLabels request. Settings can include
3772
- * filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive
3773
- * or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters
3774
- * allow specification of a maximum number of dominant colors.</p>
3777
+ * <p>Settings for the DetectLabels request. Settings can include filters for both
3778
+ * GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive or exclusive and
3779
+ * applied to individual labels or label categories. IMAGE_PROPERTIES filters allow specification
3780
+ * of a maximum number of dominant colors.</p>
3775
3781
  */
3776
3782
  export interface DetectLabelsSettings {
3777
3783
  /**
@@ -3802,7 +3808,8 @@ export interface DetectLabelsRequest {
3802
3808
  /**
3803
3809
  * @public
3804
3810
  * <p>Maximum number of labels you want the service to return in the response. The service
3805
- * returns the specified number of highest confidence labels. </p>
3811
+ * returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is
3812
+ * specified as a feature type in the Feature input parameter.</p>
3806
3813
  */
3807
3814
  MaxLabels?: number;
3808
3815
  /**
@@ -3810,22 +3817,23 @@ export interface DetectLabelsRequest {
3810
3817
  * <p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't
3811
3818
  * return any labels with confidence lower than this specified value.</p>
3812
3819
  * <p>If <code>MinConfidence</code> is not specified, the operation returns labels with a
3813
- * confidence values greater than or equal to 55 percent.</p>
3820
+ * confidence values greater than or equal to 55 percent. Only valid when GENERAL_LABELS is
3821
+ * specified as a feature type in the Feature input parameter.</p>
3814
3822
  */
3815
3823
  MinConfidence?: number;
3816
3824
  /**
3817
3825
  * @public
3818
- * <p>A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection
3819
- * feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality.
3820
- * If no option is specified GENERAL_LABELS is used by default.</p>
3826
+ * <p>A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label
3827
+ * detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color
3828
+ * and quality. If no option is specified GENERAL_LABELS is used by default.</p>
3821
3829
  */
3822
3830
  Features?: (DetectLabelsFeatureName | string)[];
3823
3831
  /**
3824
3832
  * @public
3825
- * <p>A list of the filters to be applied to returned detected labels and image properties. Specified
3826
- * filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual
3827
- * labels or label categories. The exact label names or label categories must be supplied. For
3828
- * 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>
3833
+ * <p>A list of the filters to be applied to returned detected labels and image properties.
3834
+ * Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used
3835
+ * for individual labels or label categories. The exact label names or label categories must be
3836
+ * supplied. For 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>
3829
3837
  */
3830
3838
  Settings?: DetectLabelsSettings;
3831
3839
  }
@@ -3872,7 +3880,8 @@ export interface DominantColor {
3872
3880
  }
3873
3881
  /**
3874
3882
  * @public
3875
- * <p>The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.</p>
3883
+ * <p>The quality of an image provided for label detection, with regard to brightness,
3884
+ * sharpness, and contrast.</p>
3876
3885
  */
3877
3886
  export interface DetectLabelsImageQuality {
3878
3887
  /**
@@ -3903,9 +3912,9 @@ export interface DetectLabelsImageBackground {
3903
3912
  Quality?: DetectLabelsImageQuality;
3904
3913
  /**
3905
3914
  * @public
3906
- * <p>The dominant colors found in the background of an image, defined with RGB values,
3907
- * CSS color name, simplified color name, and PixelPercentage (the percentage of
3908
- * image pixels that have a particular color).</p>
3915
+ * <p>The dominant colors found in the background of an image, defined with RGB values, CSS
3916
+ * color name, simplified color name, and PixelPercentage (the percentage of image pixels that
3917
+ * have a particular color).</p>
3909
3918
  */
3910
3919
  DominantColors?: DominantColor[];
3911
3920
  }
@@ -3921,43 +3930,42 @@ export interface DetectLabelsImageForeground {
3921
3930
  Quality?: DetectLabelsImageQuality;
3922
3931
  /**
3923
3932
  * @public
3924
- * <p>The dominant colors found in the foreground of an image, defined with RGB values,
3925
- * CSS color name, simplified color name, and PixelPercentage (the percentage of image
3926
- * pixels that have a particular color).</p>
3933
+ * <p>The dominant colors found in the foreground of an image, defined with RGB values, CSS
3934
+ * color name, simplified color name, and PixelPercentage (the percentage of image pixels that
3935
+ * have a particular color).</p>
3927
3936
  */
3928
3937
  DominantColors?: DominantColor[];
3929
3938
  }
3930
3939
  /**
3931
3940
  * @public
3932
- * <p>Information about the quality and dominant colors of an input image.
3933
- * Quality and color information is returned for the entire image, foreground, and background.</p>
3941
+ * <p>Information about the quality and dominant colors of an input image. Quality and color
3942
+ * information is returned for the entire image, foreground, and background.</p>
3934
3943
  */
3935
3944
  export interface DetectLabelsImageProperties {
3936
3945
  /**
3937
3946
  * @public
3938
- * <p>Information about the quality of the image foreground as defined by brightness,
3939
- * sharpness, and contrast. The higher the value the greater the brightness,
3940
- * sharpness, and contrast respectively.</p>
3947
+ * <p>Information about the quality of the image foreground as defined by brightness, sharpness,
3948
+ * and contrast. The higher the value the greater the brightness, sharpness, and contrast
3949
+ * respectively.</p>
3941
3950
  */
3942
3951
  Quality?: DetectLabelsImageQuality;
3943
3952
  /**
3944
3953
  * @public
3945
- * <p>Information about the dominant colors found in an image, described with RGB values,
3946
- * CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels
3947
- * that have a particular color).</p>
3954
+ * <p>Information about the dominant colors found in an image, described with RGB values, CSS
3955
+ * color name, simplified color name, and PixelPercentage (the percentage of image pixels that
3956
+ * have a particular color).</p>
3948
3957
  */
3949
3958
  DominantColors?: DominantColor[];
3950
3959
  /**
3951
3960
  * @public
3952
- * <p>Information about the properties of an image’s foreground, including the
3953
- * foreground’s quality and dominant colors, including the quality and dominant colors of the image.</p>
3961
+ * <p>Information about the properties of an image’s foreground, including the foreground’s
3962
+ * quality and dominant colors, including the quality and dominant colors of the image.</p>
3954
3963
  */
3955
3964
  Foreground?: DetectLabelsImageForeground;
3956
3965
  /**
3957
3966
  * @public
3958
- * <p>Information about the properties of an image’s background, including
3959
- * the background’s quality and dominant colors, including the quality
3960
- * and dominant colors of the image.</p>
3967
+ * <p>Information about the properties of an image’s background, including the background’s
3968
+ * quality and dominant colors, including the quality and dominant colors of the image.</p>
3961
3969
  */
3962
3970
  Background?: DetectLabelsImageBackground;
3963
3971
  }
@@ -4018,10 +4026,9 @@ export interface Parent {
4018
4026
  }
4019
4027
  /**
4020
4028
  * @public
4021
- * <p>Structure containing details about the detected label, including the name, detected instances, parent labels, and level of
4022
- * confidence.</p>
4023
- * <p>
4024
- * </p>
4029
+ * <p>Structure containing details about the detected label, including the name, detected
4030
+ * instances, parent labels, and level of confidence.</p>
4031
+ * <p> </p>
4025
4032
  */
4026
4033
  export interface Label {
4027
4034
  /**
@@ -4036,8 +4043,9 @@ export interface Label {
4036
4043
  Confidence?: number;
4037
4044
  /**
4038
4045
  * @public
4039
- * <p>If <code>Label</code> represents an object, <code>Instances</code> contains the bounding boxes for each instance of the detected object.
4040
- * Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.</p>
4046
+ * <p>If <code>Label</code> represents an object, <code>Instances</code> contains the bounding
4047
+ * boxes for each instance of the detected object. Bounding boxes are returned for common object
4048
+ * labels such as people, cars, furniture, apparel or pets.</p>
4041
4049
  */
4042
4050
  Instances?: Instance[];
4043
4051
  /**
@@ -4085,7 +4093,8 @@ export interface DetectLabelsResponse {
4085
4093
  LabelModelVersion?: string;
4086
4094
  /**
4087
4095
  * @public
4088
- * <p>Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.</p>
4096
+ * <p>Information about the properties of the input image, such as brightness, sharpness,
4097
+ * contrast, and dominant colors.</p>
4089
4098
  */
4090
4099
  ImageProperties?: DetectLabelsImageProperties;
4091
4100
  }
@@ -4541,7 +4550,8 @@ export declare const UnsuccessfulFaceDisassociationReason: {
4541
4550
  export type UnsuccessfulFaceDisassociationReason = (typeof UnsuccessfulFaceDisassociationReason)[keyof typeof UnsuccessfulFaceDisassociationReason];
4542
4551
  /**
4543
4552
  * @public
4544
- * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.</p>
4553
+ * <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully
4554
+ * disassociated.</p>
4545
4555
  */
4546
4556
  export interface UnsuccessfulFaceDisassociation {
4547
4557
  /**
@@ -4579,7 +4589,8 @@ export interface DisassociateFacesResponse {
4579
4589
  UnsuccessfulFaceDisassociations?: UnsuccessfulFaceDisassociation[];
4580
4590
  /**
4581
4591
  * @public
4582
- * <p>The status of an update made to a User. Reflects if the User has been updated for every requested change.</p>
4592
+ * <p>The status of an update made to a User. Reflects if the User has been updated for every
4593
+ * requested change.</p>
4583
4594
  */
4584
4595
  UserStatus?: UserStatus | string;
4585
4596
  }
@@ -4911,9 +4922,8 @@ export interface GetCelebrityRecognitionResponse {
4911
4922
  Celebrities?: CelebrityRecognition[];
4912
4923
  /**
4913
4924
  * @public
4914
- * <p>Job identifier for the celebrity recognition operation for which you
4915
- * want to obtain results. The job identifer is returned by an initial call
4916
- * to StartCelebrityRecognition.</p>
4925
+ * <p>Job identifier for the celebrity recognition operation for which you want to obtain
4926
+ * results. The job identifer is returned by an initial call to StartCelebrityRecognition.</p>
4917
4927
  */
4918
4928
  JobId?: string;
4919
4929
  /**
@@ -4924,9 +4934,8 @@ export interface GetCelebrityRecognitionResponse {
4924
4934
  Video?: Video;
4925
4935
  /**
4926
4936
  * @public
4927
- * <p>A job identifier specified in the call to StartCelebrityRecognition and
4928
- * returned in the job completion notification sent to your
4929
- * Amazon Simple Notification Service topic.</p>
4937
+ * <p>A job identifier specified in the call to StartCelebrityRecognition and returned in the
4938
+ * job completion notification sent to your Amazon Simple Notification Service topic.</p>
4930
4939
  */
4931
4940
  JobTag?: string;
4932
4941
  }
@@ -4965,16 +4974,15 @@ export interface GetContentModerationRequest {
4965
4974
  SortBy?: ContentModerationSortBy | string;
4966
4975
  /**
4967
4976
  * @public
4968
- * <p>Defines how to aggregate results of the StartContentModeration request.
4969
- * Default aggregation option is TIMESTAMPS.
4970
- * SEGMENTS mode aggregates moderation labels over time.</p>
4977
+ * <p>Defines how to aggregate results of the StartContentModeration request. Default
4978
+ * aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.</p>
4971
4979
  */
4972
4980
  AggregateBy?: ContentModerationAggregateBy | string;
4973
4981
  }
4974
4982
  /**
4975
4983
  * @public
4976
- * <p>Contains metadata about a content moderation request,
4977
- * including the SortBy and AggregateBy options.</p>
4984
+ * <p>Contains metadata about a content moderation request, including the SortBy and AggregateBy
4985
+ * options.</p>
4978
4986
  */
4979
4987
  export interface GetContentModerationRequestMetadata {
4980
4988
  /**
@@ -5026,9 +5034,8 @@ export interface GetContentModerationResponse {
5026
5034
  ModerationModelVersion?: string;
5027
5035
  /**
5028
5036
  * @public
5029
- * <p>Job identifier for the content moderation operation for which you
5030
- * want to obtain results. The job identifer is returned by an initial call
5031
- * to StartContentModeration.</p>
5037
+ * <p>Job identifier for the content moderation operation for which you want to obtain results.
5038
+ * The job identifer is returned by an initial call to StartContentModeration.</p>
5032
5039
  */
5033
5040
  JobId?: string;
5034
5041
  /**
@@ -5039,15 +5046,14 @@ export interface GetContentModerationResponse {
5039
5046
  Video?: Video;
5040
5047
  /**
5041
5048
  * @public
5042
- * <p>A job identifier specified in the call to StartContentModeration and
5043
- * returned in the job completion notification sent to your
5044
- * Amazon Simple Notification Service topic.</p>
5049
+ * <p>A job identifier specified in the call to StartContentModeration and returned in the job
5050
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5045
5051
  */
5046
5052
  JobTag?: string;
5047
5053
  /**
5048
5054
  * @public
5049
- * <p>Information about the paramters used when getting a response. Includes
5050
- * information on aggregation and sorting methods.</p>
5055
+ * <p>Information about the paramters used when getting a response. Includes information on
5056
+ * aggregation and sorting methods.</p>
5051
5057
  */
5052
5058
  GetRequestMetadata?: GetContentModerationRequestMetadata;
5053
5059
  }
@@ -5107,9 +5113,8 @@ export interface GetFaceDetectionResponse {
5107
5113
  Faces?: FaceDetection[];
5108
5114
  /**
5109
5115
  * @public
5110
- * <p>Job identifier for the face detection operation for which you
5111
- * want to obtain results. The job identifer is returned by an initial call
5112
- * to StartFaceDetection.</p>
5116
+ * <p>Job identifier for the face detection operation for which you want to obtain results. The
5117
+ * job identifer is returned by an initial call to StartFaceDetection.</p>
5113
5118
  */
5114
5119
  JobId?: string;
5115
5120
  /**
@@ -5120,9 +5125,8 @@ export interface GetFaceDetectionResponse {
5120
5125
  Video?: Video;
5121
5126
  /**
5122
5127
  * @public
5123
- * <p>A job identifier specified in the call to StartFaceDetection and
5124
- * returned in the job completion notification sent to your
5125
- * Amazon Simple Notification Service topic.</p>
5128
+ * <p>A job identifier specified in the call to StartFaceDetection and returned in the job
5129
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5126
5130
  */
5127
5131
  JobTag?: string;
5128
5132
  }
@@ -5169,8 +5173,8 @@ export interface GetFaceLivenessSessionResultsResponse {
5169
5173
  Status: LivenessSessionStatus | string | undefined;
5170
5174
  /**
5171
5175
  * @public
5172
- * <p>Probabalistic confidence score for if the person in the given video was live, represented as a
5173
- * float value between 0 to 100.</p>
5176
+ * <p>Probabalistic confidence score for if the person in the given video was live, represented
5177
+ * as a float value between 0 to 100.</p>
5174
5178
  */
5175
5179
  Confidence?: number;
5176
5180
  /**
@@ -5187,7 +5191,8 @@ export interface GetFaceLivenessSessionResultsResponse {
5187
5191
  * <p>A set of images from the Face Liveness video that can be used for audit purposes. It
5188
5192
  * includes a bounding box of the face and the Base64-encoded bytes that return an image. If the
5189
5193
  * CreateFaceLivenessSession request included an OutputConfig argument, the image will be
5190
- * uploaded to an S3Object specified in the output configuration.</p>
5194
+ * uploaded to an S3Object specified in the output configuration. If no Amazon S3 bucket is defined,
5195
+ * raw bytes are sent instead.</p>
5191
5196
  */
5192
5197
  AuditImages?: AuditImage[];
5193
5198
  }
@@ -5324,9 +5329,8 @@ export interface GetFaceSearchResponse {
5324
5329
  Persons?: PersonMatch[];
5325
5330
  /**
5326
5331
  * @public
5327
- * <p>Job identifier for the face search operation for which you
5328
- * want to obtain results. The job identifer is returned by an initial call
5329
- * to StartFaceSearch.</p>
5332
+ * <p>Job identifier for the face search operation for which you want to obtain results. The job
5333
+ * identifer is returned by an initial call to StartFaceSearch.</p>
5330
5334
  */
5331
5335
  JobId?: string;
5332
5336
  /**
@@ -5337,9 +5341,8 @@ export interface GetFaceSearchResponse {
5337
5341
  Video?: Video;
5338
5342
  /**
5339
5343
  * @public
5340
- * <p>A job identifier specified in the call to StartFaceSearch and
5341
- * returned in the job completion notification sent to your
5342
- * Amazon Simple Notification Service topic.</p>
5344
+ * <p>A job identifier specified in the call to StartFaceSearch and returned in the job
5345
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5343
5346
  */
5344
5347
  JobTag?: string;
5345
5348
  }
@@ -5407,8 +5410,8 @@ export interface GetLabelDetectionRequest {
5407
5410
  }
5408
5411
  /**
5409
5412
  * @public
5410
- * <p>Contains metadata about a label detection request,
5411
- * including the SortBy and AggregateBy options.</p>
5413
+ * <p>Contains metadata about a label detection request, including the SortBy and AggregateBy
5414
+ * options.</p>
5412
5415
  */
5413
5416
  export interface GetLabelDetectionRequestMetadata {
5414
5417
  /**
@@ -5493,9 +5496,8 @@ export interface GetLabelDetectionResponse {
5493
5496
  LabelModelVersion?: string;
5494
5497
  /**
5495
5498
  * @public
5496
- * <p>Job identifier for the label detection operation for which you
5497
- * want to obtain results. The job identifer is returned by an initial call
5498
- * to StartLabelDetection.</p>
5499
+ * <p>Job identifier for the label detection operation for which you want to obtain results. The
5500
+ * job identifer is returned by an initial call to StartLabelDetection.</p>
5499
5501
  */
5500
5502
  JobId?: string;
5501
5503
  /**
@@ -5506,15 +5508,14 @@ export interface GetLabelDetectionResponse {
5506
5508
  Video?: Video;
5507
5509
  /**
5508
5510
  * @public
5509
- * <p>A job identifier specified in the call to StartLabelDetection and
5510
- * returned in the job completion notification sent to your
5511
- * Amazon Simple Notification Service topic.</p>
5511
+ * <p>A job identifier specified in the call to StartLabelDetection and returned in the job
5512
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5512
5513
  */
5513
5514
  JobTag?: string;
5514
5515
  /**
5515
5516
  * @public
5516
- * <p>Information about the paramters used when getting a response. Includes
5517
- * information on aggregation and sorting methods.</p>
5517
+ * <p>Information about the paramters used when getting a response. Includes information on
5518
+ * aggregation and sorting methods.</p>
5518
5519
  */
5519
5520
  GetRequestMetadata?: GetLabelDetectionRequestMetadata;
5520
5521
  }
@@ -5615,9 +5616,8 @@ export interface GetPersonTrackingResponse {
5615
5616
  Persons?: PersonDetection[];
5616
5617
  /**
5617
5618
  * @public
5618
- * <p>Job identifier for the person tracking operation for which you
5619
- * want to obtain results. The job identifer is returned by an initial call
5620
- * to StartPersonTracking.</p>
5619
+ * <p>Job identifier for the person tracking operation for which you want to obtain results. The
5620
+ * job identifer is returned by an initial call to StartPersonTracking.</p>
5621
5621
  */
5622
5622
  JobId?: string;
5623
5623
  /**
@@ -5628,9 +5628,8 @@ export interface GetPersonTrackingResponse {
5628
5628
  Video?: Video;
5629
5629
  /**
5630
5630
  * @public
5631
- * <p>A job identifier specified in the call to StartCelebrityRecognition and
5632
- * returned in the job completion notification sent to your
5633
- * Amazon Simple Notification Service topic.</p>
5631
+ * <p>A job identifier specified in the call to StartCelebrityRecognition and returned in the
5632
+ * job completion notification sent to your Amazon Simple Notification Service topic.</p>
5634
5633
  */
5635
5634
  JobTag?: string;
5636
5635
  }
@@ -5872,9 +5871,8 @@ export interface GetSegmentDetectionResponse {
5872
5871
  SelectedSegmentTypes?: SegmentTypeInfo[];
5873
5872
  /**
5874
5873
  * @public
5875
- * <p>Job identifier for the segment detection operation for which you
5876
- * want to obtain results. The job identifer is returned by an initial call
5877
- * to StartSegmentDetection.</p>
5874
+ * <p>Job identifier for the segment detection operation for which you want to obtain results.
5875
+ * The job identifer is returned by an initial call to StartSegmentDetection.</p>
5878
5876
  */
5879
5877
  JobId?: string;
5880
5878
  /**
@@ -5885,9 +5883,8 @@ export interface GetSegmentDetectionResponse {
5885
5883
  Video?: Video;
5886
5884
  /**
5887
5885
  * @public
5888
- * <p>A job identifier specified in the call to StartSegmentDetection and
5889
- * returned in the job completion notification sent to your
5890
- * Amazon Simple Notification Service topic.</p>
5886
+ * <p>A job identifier specified in the call to StartSegmentDetection and returned in the job
5887
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5891
5888
  */
5892
5889
  JobTag?: string;
5893
5890
  }
@@ -5970,9 +5967,8 @@ export interface GetTextDetectionResponse {
5970
5967
  TextModelVersion?: string;
5971
5968
  /**
5972
5969
  * @public
5973
- * <p>Job identifier for the text detection operation for which you
5974
- * want to obtain results. The job identifer is returned by an initial call
5975
- * to StartTextDetection.</p>
5970
+ * <p>Job identifier for the text detection operation for which you want to obtain results. The
5971
+ * job identifer is returned by an initial call to StartTextDetection.</p>
5976
5972
  */
5977
5973
  JobId?: string;
5978
5974
  /**
@@ -5983,9 +5979,8 @@ export interface GetTextDetectionResponse {
5983
5979
  Video?: Video;
5984
5980
  /**
5985
5981
  * @public
5986
- * <p>A job identifier specified in the call to StartTextDetection and
5987
- * returned in the job completion notification sent to your
5988
- * Amazon Simple Notification Service topic.</p>
5982
+ * <p>A job identifier specified in the call to StartTextDetection and returned in the job
5983
+ * completion notification sent to your Amazon Simple Notification Service topic.</p>
5989
5984
  */
5990
5985
  JobTag?: string;
5991
5986
  }
@@ -6210,8 +6205,8 @@ export interface LabelDetectionSettings {
6210
6205
  /**
6211
6206
  * @public
6212
6207
  * <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
6213
- * exclusive, or a combination of both and can be applied to individual labels or entire label categories.
6214
- * To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
6208
+ * exclusive, or a combination of both and can be applied to individual labels or entire label
6209
+ * categories. To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
6215
6210
  */
6216
6211
  GeneralLabels?: GeneralLabelsSettings;
6217
6212
  }
@@ -6396,12 +6391,12 @@ export interface ListFacesRequest {
6396
6391
  MaxResults?: number;
6397
6392
  /**
6398
6393
  * @public
6399
- * <p>An array of user IDs to match when listing faces in a collection.</p>
6394
+ * <p>An array of user IDs to filter results with when listing faces in a collection.</p>
6400
6395
  */
6401
6396
  UserId?: string;
6402
6397
  /**
6403
6398
  * @public
6404
- * <p>An array of face IDs to match when listing faces in a collection.</p>
6399
+ * <p>An array of face IDs to filter results with when listing faces in a collection.</p>
6405
6400
  */
6406
6401
  FaceIds?: string[];
6407
6402
  }
@@ -6624,7 +6619,8 @@ export interface ListUsersResponse {
6624
6619
  Users?: User[];
6625
6620
  /**
6626
6621
  * @public
6627
- * <p>A pagination token to be used with the subsequent request if the response is truncated.</p>
6622
+ * <p>A pagination token to be used with the subsequent request if the response is
6623
+ * truncated.</p>
6628
6624
  */
6629
6625
  NextToken?: string;
6630
6626
  }
@@ -6938,7 +6934,8 @@ export interface SearchUsersRequest {
6938
6934
  }
6939
6935
  /**
6940
6936
  * @public
6941
- * <p>Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.</p>
6937
+ * <p>Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for
6938
+ * search.</p>
6942
6939
  */
6943
6940
  export interface SearchedFace {
6944
6941
  /**
@@ -6981,14 +6978,13 @@ export interface UserMatch {
6981
6978
  export interface SearchUsersResponse {
6982
6979
  /**
6983
6980
  * @public
6984
- * <p>An array of UserMatch objects that matched the input face along with the confidence in
6985
- * the match. Array will be empty if there are no matches.</p>
6981
+ * <p>An array of UserMatch objects that matched the input face along with the confidence in the
6982
+ * match. Array will be empty if there are no matches.</p>
6986
6983
  */
6987
6984
  UserMatches?: UserMatch[];
6988
6985
  /**
6989
6986
  * @public
6990
- * <p>Version number of the face detection model associated with the input
6991
- * CollectionId.</p>
6987
+ * <p>Version number of the face detection model associated with the input CollectionId.</p>
6992
6988
  */
6993
6989
  FaceModelVersion?: string;
6994
6990
  /**
@@ -7167,16 +7163,16 @@ export interface SearchUsersByImageResponse {
7167
7163
  FaceModelVersion?: string;
7168
7164
  /**
7169
7165
  * @public
7170
- * <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image,
7171
- * as well as the confidence in the bounding box, that was searched for matches. If no valid
7172
- * face is detected in the image the response will contain no SearchedFace object.</p>
7166
+ * <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image, as
7167
+ * well as the confidence in the bounding box, that was searched for matches. If no valid face is
7168
+ * detected in the image the response will contain no SearchedFace object.</p>
7173
7169
  */
7174
7170
  SearchedFace?: SearchedFaceDetails;
7175
7171
  /**
7176
7172
  * @public
7177
- * <p>List of UnsearchedFace objects. Contains the face details infered from the specified
7178
- * image but not used for search. Contains reasons that describe why a face wasn't used for
7179
- * Search. </p>
7173
+ * <p>List of UnsearchedFace objects. Contains the face details infered from the specified image
7174
+ * but not used for search. Contains reasons that describe why a face wasn't used for Search.
7175
+ * </p>
7180
7176
  */
7181
7177
  UnsearchedFaces?: UnsearchedFace[];
7182
7178
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rekognition",
3
3
  "description": "AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native",
4
- "version": "3.385.0",
4
+ "version": "3.386.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.385.0",
25
- "@aws-sdk/credential-provider-node": "3.385.0",
24
+ "@aws-sdk/client-sts": "3.386.0",
25
+ "@aws-sdk/credential-provider-node": "3.386.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.382.0",
30
+ "@aws-sdk/middleware-user-agent": "3.386.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.382.0",
32
+ "@aws-sdk/util-endpoints": "3.386.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",