@aws-sdk/client-rekognition 3.224.0 → 3.229.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/dist-cjs/endpoint/ruleset.js +1 -10
  2. package/dist-cjs/models/models_0.js +19 -6
  3. package/dist-cjs/protocols/Aws_json1_1.js +20 -0
  4. package/dist-cjs/runtimeConfig.browser.js +3 -3
  5. package/dist-cjs/runtimeConfig.js +2 -1
  6. package/dist-es/endpoint/ruleset.js +1 -10
  7. package/dist-es/models/models_0.js +12 -0
  8. package/dist-es/protocols/Aws_json1_1.js +20 -0
  9. package/dist-es/runtimeConfig.browser.js +1 -1
  10. package/dist-es/runtimeConfig.js +2 -1
  11. package/dist-types/Rekognition.d.ts +85 -120
  12. package/dist-types/commands/CompareFacesCommand.d.ts +0 -1
  13. package/dist-types/commands/CopyProjectVersionCommand.d.ts +0 -3
  14. package/dist-types/commands/CreateDatasetCommand.d.ts +0 -6
  15. package/dist-types/commands/CreateProjectVersionCommand.d.ts +0 -10
  16. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +4 -5
  17. package/dist-types/commands/DescribeCollectionCommand.d.ts +0 -1
  18. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +0 -19
  19. package/dist-types/commands/DetectLabelsCommand.d.ts +3 -8
  20. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +0 -1
  21. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +0 -3
  22. package/dist-types/commands/DetectTextCommand.d.ts +0 -1
  23. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +0 -1
  24. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +0 -1
  25. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +0 -1
  26. package/dist-types/commands/GetContentModerationCommand.d.ts +0 -3
  27. package/dist-types/commands/GetFaceSearchCommand.d.ts +0 -2
  28. package/dist-types/commands/GetLabelDetectionCommand.d.ts +64 -19
  29. package/dist-types/commands/GetPersonTrackingCommand.d.ts +0 -5
  30. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +0 -1
  31. package/dist-types/commands/IndexFacesCommand.d.ts +0 -3
  32. package/dist-types/commands/ListCollectionsCommand.d.ts +0 -1
  33. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +0 -1
  34. package/dist-types/commands/PutProjectPolicyCommand.d.ts +0 -4
  35. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +0 -1
  36. package/dist-types/commands/SearchFacesByImageCommand.d.ts +0 -1
  37. package/dist-types/commands/SearchFacesCommand.d.ts +0 -1
  38. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +0 -1
  39. package/dist-types/commands/StartContentModerationCommand.d.ts +1 -2
  40. package/dist-types/commands/StartFaceDetectionCommand.d.ts +0 -1
  41. package/dist-types/commands/StartLabelDetectionCommand.d.ts +12 -2
  42. package/dist-types/commands/StartProjectVersionCommand.d.ts +0 -2
  43. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +0 -2
  44. package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +0 -6
  46. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  47. package/dist-types/models/models_0.d.ts +60 -29
  48. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  49. package/dist-types/runtimeConfig.d.ts +1 -1
  50. package/dist-types/runtimeConfig.native.d.ts +1 -1
  51. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  52. package/dist-types/ts3.4/models/models_0.d.ts +19 -0
  53. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +4 -1
  54. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -1
  55. package/dist-types/ts3.4/runtimeConfig.native.d.ts +4 -1
  56. package/package.json +30 -29
@@ -10,13 +10,10 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
10
10
  /**
11
11
  * <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
12
12
  * an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
13
- *
14
13
  * <p>To create a training dataset for a project, specify <code>train</code> for the value of
15
14
  * <code>DatasetType</code>. To create the test dataset for a project,
16
15
  * specify <code>test</code> for the value of <code>DatasetType</code>.
17
16
  * </p>
18
- *
19
- *
20
17
  * <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset.
21
18
  * Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> to check the
22
19
  * current status. The dataset created successfully if the value of <code>Status</code> is
@@ -27,10 +24,7 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
27
24
  * Currently, you can't access the terminal error information.
28
25
  *
29
26
  * </p>
30
- *
31
- *
32
27
  * <p>For more information, see Creating dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.</p>
33
- *
34
28
  * <p>This operation requires permissions to perform the <code>rekognition:CreateDataset</code> action.
35
29
  * If you want to copy an existing dataset, you also require permission to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
36
30
  * @example
@@ -12,13 +12,9 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
12
12
  * Models are managed as part of an Amazon Rekognition Custom Labels project.
13
13
  * The response from <code>CreateProjectVersion</code>
14
14
  * is an Amazon Resource Name (ARN) for the version of the model. </p>
15
- *
16
- *
17
15
  * <p>Training uses the training and test datasets associated with the project.
18
16
  * For more information, see Creating training and test dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
19
17
  * </p>
20
- *
21
- *
22
18
  * <note>
23
19
  * <p>You can train a model in a project that doesn't have associated datasets by specifying manifest files in the
24
20
  * <code>TrainingData</code> and <code>TestingData</code> fields.
@@ -30,21 +26,15 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
30
26
  * we recommend that you use the manifest
31
27
  * files to create training and test datasets for the project.</p>
32
28
  * </note>
33
- *
34
- *
35
29
  * <p>Training takes a while to complete. You can get the current status by calling
36
30
  * <a>DescribeProjectVersions</a>. Training completed successfully if
37
31
  * the value of the <code>Status</code> field is <code>TRAINING_COMPLETED</code>.</p>
38
- *
39
32
  * <p>If training
40
33
  * fails, see Debugging a failed model training in the <i>Amazon Rekognition Custom Labels</i> developer guide. </p>
41
- *
42
- *
43
34
  * <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
44
35
  * get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model
45
36
  * in the <i>Amazon Rekognition Custom Labels</i> developers guide.
46
37
  * </p>
47
- *
48
38
  * <p>After evaluating the model, you start the model
49
39
  * by calling <a>StartProjectVersion</a>.</p>
50
40
  * <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
@@ -9,8 +9,8 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
9
9
  }
10
10
  /**
11
11
  * <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.</p>
12
- * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
13
- * <ul>
12
+ * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
13
+ * <ul>
14
14
  * <li>
15
15
  * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
16
16
  * face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
@@ -23,12 +23,11 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
23
23
  * When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
24
24
  * </li>
25
25
  * </ul>
26
- *
27
- * <p>
26
+ * <p>
28
27
  * Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
29
28
  * to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
30
29
  * the <code>Name</code> field. </p>
31
- * <p>This operation requires permissions to perform the
30
+ * <p>This operation requires permissions to perform the
32
31
  * <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
33
32
  * @example
34
33
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,7 +11,6 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
11
11
  * <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
12
12
  * information, such as the number of faces indexed into a collection and the version of the
13
13
  * model used by the collection for face detection.</p>
14
- *
15
14
  * <p>For more information, see Describing a Collection in the
16
15
  * Amazon Rekognition Developer Guide.</p>
17
16
  * @example
@@ -19,16 +19,6 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
19
19
  * Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
20
20
  * of confidence that the image contains the object (<code>Confidence</code>), and
21
21
  * object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
22
- *
23
- *
24
- *
25
- *
26
- *
27
- *
28
- *
29
- *
30
- *
31
- *
32
22
  * <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
33
23
  * <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
34
24
  * the specified value.
@@ -42,21 +32,12 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
42
32
  * You can use <code>MinConfidence</code> to change the precision and recall or your model.
43
33
  * For more information, see
44
34
  * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
45
- *
46
35
  * <p>If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code>
47
36
  * returns labels based on the assumed threshold of each label.</p>
48
- *
49
- *
50
- *
51
- *
52
- *
53
37
  * <p>This is a stateless API operation. That is, the operation does not persist any
54
38
  * data.</p>
55
39
  * <p>This operation requires permissions to perform the
56
40
  * <code>rekognition:DetectCustomLabels</code> action. </p>
57
- *
58
- *
59
- *
60
41
  * <p>For more information, see
61
42
  * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
62
43
  * @example
@@ -11,10 +11,8 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
11
11
  * <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
12
12
  * input. This includes objects like flower, tree, and table; events like wedding, graduation,
13
13
  * and birthday party; and concepts like landscape, evening, and nature. </p>
14
- *
15
14
  * <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
16
15
  * Amazon Rekognition Developer Guide.</p>
17
- *
18
16
  * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
19
17
  * an Amazon S3 bucket. If you use the
20
18
  * AWS
@@ -61,8 +59,7 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
61
59
  * <p> Aliases - Possible Aliases for the label. </p>
62
60
  * </li>
63
61
  * <li>
64
- * <p> Categories - The label categories that the detected label belongs to. A given label
65
- * can belong to more than one category. </p>
62
+ * <p> Categories - The label categories that the detected label belongs to. </p>
66
63
  * </li>
67
64
  * <li>
68
65
  * <p> BoundingBox — Bounding boxes are described for all instances of detected common
@@ -83,12 +80,10 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
83
80
  * <p>Dominant Color - An array of the dominant colors in the image. </p>
84
81
  * </li>
85
82
  * <li>
86
- * <p>Foreground - Information about the Sharpness and Brightness of the input image’s
87
- * foreground. </p>
83
+ * <p>Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground. </p>
88
84
  * </li>
89
85
  * <li>
90
- * <p>Background - Information about the Sharpness and Brightness of the input image’s
91
- * background.</p>
86
+ * <p>Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.</p>
92
87
  * </li>
93
88
  * </ul>
94
89
  * <p>The list of returned labels will include at least one label for every detected object,
@@ -14,7 +14,6 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
14
14
  * suggestive content.</p>
15
15
  * <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to
16
16
  * determine which types of content are appropriate.</p>
17
- *
18
17
  * <p>For information about moderation labels, see Detecting Unsafe Content in the
19
18
  * Amazon Rekognition Developer Guide.</p>
20
19
  * <p>You pass the input image either as base64-encoded image bytes or as a reference to an
@@ -21,10 +21,8 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective
21
21
  * <p>Head cover</p>
22
22
  * </li>
23
23
  * </ul>
24
- *
25
24
  * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
26
25
  * The image must be either a PNG or JPG formatted file. </p>
27
- *
28
26
  * <p>
29
27
  * <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>
30
28
  * <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).
@@ -46,7 +44,6 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective
46
44
  * </li>
47
45
  * </ul>
48
46
  * <p>This is a stateless API operation. That is, the operation does not persist any data.</p>
49
- *
50
47
  * <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>
51
48
  * @example
52
49
  * Use a bare-bones client and the command you need to make an API call.
@@ -29,7 +29,6 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
29
29
  * use the <code>TextDetection</code> object <code>Type</code> field. </p>
30
30
  * <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
31
31
  * axis.</p>
32
- *
33
32
  * <p>For more information, see Detecting text in the Amazon Rekognition Developer
34
33
  * Guide.</p>
35
34
  * @example
@@ -18,7 +18,6 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
18
18
  * <p>Distributing a dataset takes a while to complete. To check the status call <code>DescribeDataset</code>. The operation
19
19
  * is complete when the <code>Status</code> field for the training dataset and the test dataset is <code>UPDATE_COMPLETE</code>.
20
20
  * If the dataset split fails, the value of <code>Status</code> is <code>UPDATE_FAILED</code>.</p>
21
- *
22
21
  * <p>This operation requires permissions to perform the <code>rekognition:DistributeDatasetEntries</code> action.</p>
23
22
  * @example
24
23
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,7 +11,6 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
11
11
  * <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
12
12
  * The additional information is returned as an array of URLs. If there is no additional
13
13
  * information about the celebrity, this list is empty.</p>
14
- *
15
14
  * <p>For more information, see Getting information about a celebrity in the
16
15
  * Amazon Rekognition Developer Guide.</p>
17
16
  * <p>This operation requires permissions to perform the
@@ -19,7 +19,6 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
19
19
  * analysis, first check that the status value published to the Amazon SNS topic is
20
20
  * <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job
21
21
  * identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
22
- *
23
22
  * <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
24
23
  * <p>
25
24
  * <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they
@@ -11,7 +11,6 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
11
11
  * <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
12
12
  * <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
13
13
  * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
14
- *
15
14
  * <p>Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling
16
15
  * <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).
17
16
  * When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
@@ -19,7 +18,6 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
19
18
  * To get the results of the content analysis, first check that the status value published to the Amazon SNS
20
19
  * topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier
21
20
  * (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
22
- *
23
21
  * <p>For more information, see Working with Stored Videos in the
24
22
  * Amazon Rekognition Devlopers Guide.</p>
25
23
  * <p>
@@ -36,7 +34,6 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
36
34
  * pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>
37
35
  * and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
38
36
  * returned from the previous call to <code>GetContentModeration</code>.</p>
39
- *
40
37
  * <p>For more information, see moderating content in the Amazon Rekognition Developer Guide.</p>
41
38
  * @example
42
39
  * Use a bare-bones client and the command you need to make an API call.
@@ -18,7 +18,6 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
18
18
  * To get the search results, first check that the status value published to the Amazon SNS
19
19
  * topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier
20
20
  * (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>.</p>
21
- *
22
21
  * <p>For more information, see Searching Faces in a Collection in the
23
22
  * Amazon Rekognition Developer Guide.</p>
24
23
  * <p>The search results are retured in an array, <code>Persons</code>, of
@@ -34,7 +33,6 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
34
33
  * in the <code>Face</code> object of the following response syntax are not returned. For more information,
35
34
  * see FaceDetail in the Amazon Rekognition Developer Guide. </p>
36
35
  * </note>
37
- *
38
36
  * <p>By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the
39
37
  * start of the video, persons are matched.
40
38
  * You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input
@@ -9,26 +9,71 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
9
9
  }
10
10
  /**
11
11
  * <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
12
- *
13
- * <p>The label detection operation is started by a call to <a>StartLabelDetection</a>
14
- * which returns a job identifier (<code>JobId</code>). When the label detection operation finishes, Amazon Rekognition publishes a completion status to
15
- * the Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. To get the results
16
- * of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
17
- * If so, call <a>GetLabelDetection</a> and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
12
+ * <p>The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When
13
+ * the label detection operation finishes, Amazon Rekognition publishes a completion status to the
14
+ * Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. </p>
15
+ * <p>To get the results of the label detection operation, first check that the status value
16
+ * published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<code>JobId</code>) from the
17
+ * initial call to <code>StartLabelDetection</code>.</p>
19
18
  * <p>
20
- * <code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) sorted by the time
21
- * the labels were detected. You can also sort by the label name by specifying <code>NAME</code> for the
22
- * <code>SortBy</code> input parameter.</p>
23
- * <p>The labels returned include the label name, the percentage confidence in the accuracy of the detected label,
24
- * and the time the label was detected in the video.</p>
25
- * <p>The returned labels also include bounding box information for common objects, a
26
- * hierarchical taxonomy of detected labels, and the version of the label model used for detection.</p>
27
- *
28
- * <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
29
- * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
30
- * of results. To get the next page of results, call <code>GetlabelDetection</code> and populate the <code>NextToken</code> request parameter with the token
31
- * value returned from the previous call to <code>GetLabelDetection</code>.</p>
19
+ * <code>GetLabelDetection</code> returns an array of detected labels
20
+ * (<code>Labels</code>) sorted by the time the labels were detected. You can also sort by the
21
+ * label name by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. If
22
+ * there is no <code>NAME</code> specified, the default sort is by
23
+ * timestamp.</p>
24
+ * <p>You can select how results are aggregated by using the <code>AggregateBy</code> input
25
+ * parameter. The default aggregation method is <code>TIMESTAMPS</code>. You can also aggregate
26
+ * by <code>SEGMENTS</code>, which aggregates all instances of labels detected in a given
27
+ * segment. </p>
28
+ * <p>The returned Labels array may include the following attributes:</p>
29
+ * <ul>
30
+ * <li>
31
+ * <p>Name - The name of the detected label.</p>
32
+ * </li>
33
+ * <li>
34
+ * <p>Confidence - The level of confidence in the label assigned to a detected object. </p>
35
+ * </li>
36
+ * <li>
37
+ * <p>Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical
38
+ * taxonomy of detected labels. For example, a detected car might be assigned the label car.
39
+ * The label car has two parent labels: Vehicle (its parent) and Transportation (its
40
+ * grandparent). The response includes the all ancestors for a label, where every ancestor is
41
+ * a unique label. In the previous example, Car, Vehicle, and Transportation are returned as
42
+ * unique labels in the response. </p>
43
+ * </li>
44
+ * <li>
45
+ * <p> Aliases - Possible Aliases for the label. </p>
46
+ * </li>
47
+ * <li>
48
+ * <p>Categories - The label categories that the detected label belongs to.</p>
49
+ * </li>
50
+ * <li>
51
+ * <p>BoundingBox — Bounding boxes are described for all instances of detected common object labels,
52
+ * returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing
53
+ * the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.</p>
54
+ * </li>
55
+ * <li>
56
+ * <p>Timestamp - Time, in milliseconds from the start of the video, that the label was detected.
57
+ * For aggregation by <code>SEGMENTS</code>, the <code>StartTimestampMillis</code>,
58
+ * <code>EndTimestampMillis</code>, and <code>DurationMillis</code> structures are what
59
+ * define a segment. Although the “Timestamp” structure is still returned with each label,
60
+ * its value is set to be the same as <code>StartTimestampMillis</code>.</p>
61
+ * </li>
62
+ * </ul>
63
+ * <p>Timestamp and Bounding box information are returned for detected Instances, only if
64
+ * aggregation is done by <code>TIMESTAMPS</code>. If aggregating by <code>SEGMENTS</code>,
65
+ * information about detected instances isn’t returned. </p>
66
+ * <p>The version of the label model used for the detection is also returned.</p>
67
+ * <p>
68
+ * <b>Note <code>DominantColors</code> isn't returned for <code>Instances</code>,
69
+ * although it is shown as part of the response in the sample seen below.</b>
70
+ * </p>
71
+ * <p>Use <code>MaxResults</code> parameter to limit the number of labels returned. If
72
+ * there are more results than specified in <code>MaxResults</code>, the value of
73
+ * <code>NextToken</code> in the operation response contains a pagination token for getting the
74
+ * next set of results. To get the next page of results, call <code>GetlabelDetection</code> and
75
+ * populate the <code>NextToken</code> request parameter with the token value returned from the
76
+ * previous call to <code>GetLabelDetection</code>.</p>
32
77
  * @example
33
78
  * Use a bare-bones client and the command you need to make an API call.
34
79
  * ```javascript
@@ -9,7 +9,6 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
9
9
  }
10
10
  /**
11
11
  * <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
12
- *
13
12
  * <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
14
13
  * which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
15
14
  * the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>
@@ -26,14 +25,10 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
26
25
  * facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
27
26
  * <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
28
27
  * in the <code>Face</code> object of the following response syntax are not returned. </p>
29
- *
30
28
  * <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p>
31
29
  * </note>
32
- *
33
- *
34
30
  * <p>By default, the array is sorted by the time(s) a person's path is tracked in the video.
35
31
  * You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p>
36
- *
37
32
  * <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than
38
33
  * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
39
34
  * of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token
@@ -29,7 +29,6 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes
29
29
  * a pagination token for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code>
30
30
  * and populate the <code>NextToken</code> request parameter with the token value returned from the previous
31
31
  * call to <code>GetSegmentDetection</code>.</p>
32
- *
33
32
  * <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
34
33
  * @example
35
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -14,7 +14,6 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
14
14
  * extracts facial features into a feature vector, and stores it in the backend database.
15
15
  * Amazon Rekognition uses feature vectors when it performs face match and search operations using the
16
16
  * <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations.</p>
17
- *
18
17
  * <p>For more information, see Adding faces to a collection in the Amazon Rekognition
19
18
  * Developer Guide.</p>
20
19
  * <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
@@ -27,7 +26,6 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
27
26
  * version from the value of <code>FaceModelVersion</code> in the response from
28
27
  * <code>IndexFaces</code>
29
28
  * </p>
30
- *
31
29
  * <p>For more information, see Model Versioning in the Amazon Rekognition Developer
32
30
  * Guide.</p>
33
31
  * <p>If you provide the optional <code>ExternalImageId</code> for the input image you
@@ -96,7 +94,6 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
96
94
  * image, specify the same collection, and use the same external ID in the
97
95
  * <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
98
96
  * <p></p>
99
- *
100
97
  * <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
101
98
  * image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
102
99
  * passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
@@ -11,7 +11,6 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
11
11
  * <p>Returns list of collection IDs in your account. If the result is truncated, the
12
12
  * response also provides a <code>NextToken</code> that you can use in the subsequent request to
13
13
  * fetch the next set of collection IDs.</p>
14
- *
15
14
  * <p>For an example, see Listing collections in the Amazon Rekognition Developer
16
15
  * Guide.</p>
17
16
  * <p>This operation requires permissions to perform the
@@ -19,7 +19,6 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
19
19
  * same information is reported in the training and testing validation result manifests that
20
20
  * Amazon Rekognition Custom Labels creates during model training.
21
21
  * </p>
22
- *
23
22
  * <p>You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
24
23
  * </p>
25
24
  * <p>This operation requires permissions to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
@@ -12,18 +12,14 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
12
12
  * project policy specifies that a trusted AWS account can copy a model version from a
13
13
  * trusting AWS account to a project in the trusted AWS account. To copy a model version you use
14
14
  * the <a>CopyProjectVersion</a> operation.</p>
15
- *
16
- *
17
15
  * <p>For more information about the format of a project policy document, see Attaching a project policy (SDK)
18
16
  * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
19
17
  * </p>
20
- *
21
18
  * <p>The response from <code>PutProjectPolicy</code> is a revision ID for the project policy.
22
19
  * You can attach multiple project policies to a project. You can also update an existing
23
20
  * project policy by specifying the policy revision ID of the existing policy.</p>
24
21
  * <p>To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.
25
22
  * To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. </p>
26
- *
27
23
  * <p>You copy a model version by calling <a>CopyProjectVersion</a>.</p>
28
24
  * @example
29
25
  * Use a bare-bones client and the command you need to make an API call.
@@ -31,7 +31,6 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
31
31
  * AWS
32
32
  * CLI to call Amazon Rekognition operations, passing image bytes is not
33
33
  * supported. The image must be either a PNG or JPEG formatted file. </p>
34
- *
35
34
  * <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition
36
35
  * Developer Guide.</p>
37
36
  * <p>This operation requires permissions to perform the
@@ -31,7 +31,6 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
31
31
  * face that Amazon Rekognition used for the input image. </p>
32
32
  * <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
33
33
  * <code>InvalidParameterException</code> error. </p>
34
- *
35
34
  * <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition
36
35
  * Developer Guide.</p>
37
36
  * <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
@@ -20,7 +20,6 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
20
20
  * each face match that is found. Along with the metadata, the response also includes a
21
21
  * <code>confidence</code> value for each face match, indicating the confidence that the
22
22
  * specific face matches the input face. </p>
23
- *
24
23
  * <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition
25
24
  * Developer Guide.</p>
26
25
  * <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
@@ -18,7 +18,6 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe
18
18
  * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
19
19
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
20
20
  * (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
21
- *
22
21
  * <p>For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.</p>
23
22
  * @example
24
23
  * Use a bare-bones client and the command you need to make an API call.
@@ -15,10 +15,9 @@ export interface StartContentModerationCommandOutput extends StartContentModerat
15
15
  * returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
16
16
  * When content analysis is finished, Amazon Rekognition Video publishes a completion status
17
17
  * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
18
- * <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
18
+ * <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
19
19
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
20
20
  * (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
21
- *
22
21
  * <p>For more information, see Moderating content in the Amazon Rekognition Developer Guide.</p>
23
22
  * @example
24
23
  * Use a bare-bones client and the command you need to make an API call.
@@ -18,7 +18,6 @@ export interface StartFaceDetectionCommandOutput extends StartFaceDetectionRespo
18
18
  * To get the results of the face detection operation, first check that the status value published to the Amazon SNS
19
19
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
20
20
  * (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
21
- *
22
21
  * <p>For more information, see Detecting faces in a stored video in the
23
22
  * Amazon Rekognition Developer Guide.</p>
24
23
  * @example
@@ -13,7 +13,6 @@ export interface StartLabelDetectionCommandOutput extends StartLabelDetectionRes
13
13
  * This includes objects like flower, tree, and table; events like
14
14
  * wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities
15
15
  * like a person getting out of a car or a person skiing.</p>
16
- *
17
16
  * <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
18
17
  * and the filename of the video.
19
18
  * <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the
@@ -22,7 +21,18 @@ export interface StartLabelDetectionCommandOutput extends StartLabelDetectionRes
22
21
  * <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS
23
22
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier
24
23
  * (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
25
- * <p></p>
24
+ * <p>
25
+ * <i>Optional Parameters</i>
26
+ * </p>
27
+ * <p>
28
+ * <code>StartLabelDetection</code> has the <code>GENERAL_LABELS</code> Feature applied by
29
+ * default. This feature allows you to provide filtering criteria to the <code>Settings</code>
30
+ * parameter. You can filter with sets of individual labels or with label categories. You can
31
+ * specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive
32
+ * filters. For more information on filtering, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html">Detecting labels in a
33
+ * video</a>.</p>
34
+ * <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
35
+ * labels returned. The default is 50.</p>
26
36
  * @example
27
37
  * Use a bare-bones client and the command you need to make an API call.
28
38
  * ```javascript
@@ -16,9 +16,7 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes
16
16
  * <p>You are charged for the amount of time that the model is running. To stop a running
17
17
  * model, call <a>StopProjectVersion</a>.</p>
18
18
  * </note>
19
- *
20
19
  * <p>For more information, see <i>Running a trained Amazon Rekognition Custom Labels model</i> in the Amazon Rekognition Custom Labels Guide.</p>
21
- *
22
20
  * <p>This operation requires permissions to perform the
23
21
  * <code>rekognition:StartProjectVersion</code> action.</p>
24
22
  * @example
@@ -21,8 +21,6 @@ export interface StartSegmentDetectionCommandOutput extends StartSegmentDetectio
21
21
  * <p>To get the results of the segment detection operation, first check that the status value published to the Amazon SNS
22
22
  * topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<code>JobId</code>)
23
23
  * from the initial call to <code>StartSegmentDetection</code>. </p>
24
- *
25
- *
26
24
  * <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
27
25
  * @example
28
26
  * Use a bare-bones client and the command you need to make an API call.
@@ -11,7 +11,7 @@ export interface StartStreamProcessorCommandOutput extends StartStreamProcessorR
11
11
  * <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
12
12
  * To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
13
13
  * <code>CreateStreamProcessor</code>.</p>
14
- * <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
14
+ * <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript