@aws-sdk/client-rekognition 3.36.0 → 3.39.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 (154) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Rekognition.js +0 -3
  3. package/dist-cjs/RekognitionClient.js +0 -8
  4. package/dist-cjs/commands/CompareFacesCommand.js +0 -86
  5. package/dist-cjs/commands/CreateCollectionCommand.js +0 -36
  6. package/dist-cjs/commands/CreateProjectCommand.js +0 -26
  7. package/dist-cjs/commands/CreateProjectVersionCommand.js +0 -35
  8. package/dist-cjs/commands/CreateStreamProcessorCommand.js +0 -34
  9. package/dist-cjs/commands/DeleteCollectionCommand.js +0 -28
  10. package/dist-cjs/commands/DeleteFacesCommand.js +0 -27
  11. package/dist-cjs/commands/DeleteProjectCommand.js +0 -27
  12. package/dist-cjs/commands/DeleteProjectVersionCommand.js +0 -31
  13. package/dist-cjs/commands/DeleteStreamProcessorCommand.js +0 -25
  14. package/dist-cjs/commands/DescribeCollectionCommand.js +0 -29
  15. package/dist-cjs/commands/DescribeProjectVersionsCommand.js +0 -28
  16. package/dist-cjs/commands/DescribeProjectsCommand.js +0 -25
  17. package/dist-cjs/commands/DescribeStreamProcessorCommand.js +0 -25
  18. package/dist-cjs/commands/DetectCustomLabelsCommand.js +0 -74
  19. package/dist-cjs/commands/DetectFacesCommand.js +0 -46
  20. package/dist-cjs/commands/DetectLabelsCommand.js +0 -96
  21. package/dist-cjs/commands/DetectModerationLabelsCommand.js +0 -37
  22. package/dist-cjs/commands/DetectProtectiveEquipmentCommand.js +0 -63
  23. package/dist-cjs/commands/DetectTextCommand.js +0 -45
  24. package/dist-cjs/commands/GetCelebrityInfoCommand.js +0 -31
  25. package/dist-cjs/commands/GetCelebrityRecognitionCommand.js +0 -58
  26. package/dist-cjs/commands/GetContentModerationCommand.js +0 -53
  27. package/dist-cjs/commands/GetFaceDetectionCommand.js +0 -36
  28. package/dist-cjs/commands/GetFaceSearchCommand.js +0 -54
  29. package/dist-cjs/commands/GetLabelDetectionCommand.js +0 -44
  30. package/dist-cjs/commands/GetPersonTrackingCommand.js +0 -53
  31. package/dist-cjs/commands/GetSegmentDetectionCommand.js +0 -46
  32. package/dist-cjs/commands/GetTextDetectionCommand.js +0 -42
  33. package/dist-cjs/commands/IndexFacesCommand.js +0 -123
  34. package/dist-cjs/commands/ListCollectionsCommand.js +0 -29
  35. package/dist-cjs/commands/ListFacesCommand.js +0 -31
  36. package/dist-cjs/commands/ListStreamProcessorsCommand.js +0 -24
  37. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -28
  38. package/dist-cjs/commands/RecognizeCelebritiesCommand.js +0 -54
  39. package/dist-cjs/commands/SearchFacesByImageCommand.js +0 -70
  40. package/dist-cjs/commands/SearchFacesCommand.js +0 -44
  41. package/dist-cjs/commands/StartCelebrityRecognitionCommand.js +0 -35
  42. package/dist-cjs/commands/StartContentModerationCommand.js +0 -35
  43. package/dist-cjs/commands/StartFaceDetectionCommand.js +0 -36
  44. package/dist-cjs/commands/StartFaceSearchCommand.js +0 -33
  45. package/dist-cjs/commands/StartLabelDetectionCommand.js +0 -38
  46. package/dist-cjs/commands/StartPersonTrackingCommand.js +0 -32
  47. package/dist-cjs/commands/StartProjectVersionCommand.js +0 -33
  48. package/dist-cjs/commands/StartSegmentDetectionCommand.js +0 -39
  49. package/dist-cjs/commands/StartStreamProcessorCommand.js +0 -26
  50. package/dist-cjs/commands/StartTextDetectionCommand.js +0 -31
  51. package/dist-cjs/commands/StopProjectVersionCommand.js +0 -25
  52. package/dist-cjs/commands/StopStreamProcessorCommand.js +0 -24
  53. package/dist-cjs/commands/TagResourceCommand.js +0 -28
  54. package/dist-cjs/commands/UntagResourceCommand.js +0 -28
  55. package/dist-cjs/commands/index.js +54 -0
  56. package/dist-cjs/endpoints.js +6 -1
  57. package/dist-cjs/index.js +5 -69
  58. package/dist-cjs/models/models_0.js +0 -621
  59. package/dist-cjs/pagination/DescribeProjectVersionsPaginator.js +0 -10
  60. package/dist-cjs/pagination/DescribeProjectsPaginator.js +0 -10
  61. package/dist-cjs/pagination/GetCelebrityRecognitionPaginator.js +0 -10
  62. package/dist-cjs/pagination/GetContentModerationPaginator.js +0 -10
  63. package/dist-cjs/pagination/GetFaceDetectionPaginator.js +0 -10
  64. package/dist-cjs/pagination/GetFaceSearchPaginator.js +0 -10
  65. package/dist-cjs/pagination/GetLabelDetectionPaginator.js +0 -10
  66. package/dist-cjs/pagination/GetPersonTrackingPaginator.js +0 -10
  67. package/dist-cjs/pagination/GetSegmentDetectionPaginator.js +0 -10
  68. package/dist-cjs/pagination/GetTextDetectionPaginator.js +0 -10
  69. package/dist-cjs/pagination/ListCollectionsPaginator.js +0 -10
  70. package/dist-cjs/pagination/ListFacesPaginator.js +0 -10
  71. package/dist-cjs/pagination/ListStreamProcessorsPaginator.js +0 -10
  72. package/dist-cjs/pagination/index.js +17 -0
  73. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  74. package/dist-cjs/runtimeConfig.browser.js +1 -5
  75. package/dist-cjs/runtimeConfig.js +1 -5
  76. package/dist-cjs/runtimeConfig.native.js +0 -3
  77. package/dist-cjs/runtimeConfig.shared.js +0 -3
  78. package/dist-cjs/waiters/index.js +5 -0
  79. package/dist-cjs/waiters/waitForProjectVersionRunning.js +0 -9
  80. package/dist-cjs/waiters/waitForProjectVersionTrainingCompleted.js +0 -9
  81. package/dist-es/commands/index.js +51 -0
  82. package/dist-es/endpoints.js +6 -1
  83. package/dist-es/index.js +5 -69
  84. package/dist-es/pagination/index.js +14 -0
  85. package/dist-es/waiters/index.js +2 -0
  86. package/dist-types/commands/index.d.ts +51 -0
  87. package/dist-types/index.d.ts +5 -69
  88. package/dist-types/pagination/index.d.ts +14 -0
  89. package/dist-types/ts3.4/Rekognition.d.ts +52 -1018
  90. package/dist-types/ts3.4/RekognitionClient.d.ts +24 -89
  91. package/dist-types/ts3.4/commands/CompareFacesCommand.d.ts +2 -82
  92. package/dist-types/ts3.4/commands/CreateCollectionCommand.d.ts +2 -32
  93. package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +2 -22
  94. package/dist-types/ts3.4/commands/CreateProjectVersionCommand.d.ts +2 -31
  95. package/dist-types/ts3.4/commands/CreateStreamProcessorCommand.d.ts +2 -30
  96. package/dist-types/ts3.4/commands/DeleteCollectionCommand.d.ts +2 -24
  97. package/dist-types/ts3.4/commands/DeleteFacesCommand.d.ts +2 -23
  98. package/dist-types/ts3.4/commands/DeleteProjectCommand.d.ts +2 -23
  99. package/dist-types/ts3.4/commands/DeleteProjectVersionCommand.d.ts +2 -27
  100. package/dist-types/ts3.4/commands/DeleteStreamProcessorCommand.d.ts +2 -21
  101. package/dist-types/ts3.4/commands/DescribeCollectionCommand.d.ts +2 -25
  102. package/dist-types/ts3.4/commands/DescribeProjectVersionsCommand.d.ts +2 -24
  103. package/dist-types/ts3.4/commands/DescribeProjectsCommand.d.ts +2 -21
  104. package/dist-types/ts3.4/commands/DescribeStreamProcessorCommand.d.ts +2 -21
  105. package/dist-types/ts3.4/commands/DetectCustomLabelsCommand.d.ts +2 -70
  106. package/dist-types/ts3.4/commands/DetectFacesCommand.d.ts +2 -42
  107. package/dist-types/ts3.4/commands/DetectLabelsCommand.d.ts +2 -92
  108. package/dist-types/ts3.4/commands/DetectModerationLabelsCommand.d.ts +2 -33
  109. package/dist-types/ts3.4/commands/DetectProtectiveEquipmentCommand.d.ts +2 -59
  110. package/dist-types/ts3.4/commands/DetectTextCommand.d.ts +2 -41
  111. package/dist-types/ts3.4/commands/GetCelebrityInfoCommand.d.ts +2 -27
  112. package/dist-types/ts3.4/commands/GetCelebrityRecognitionCommand.d.ts +2 -54
  113. package/dist-types/ts3.4/commands/GetContentModerationCommand.d.ts +2 -49
  114. package/dist-types/ts3.4/commands/GetFaceDetectionCommand.d.ts +2 -32
  115. package/dist-types/ts3.4/commands/GetFaceSearchCommand.d.ts +2 -50
  116. package/dist-types/ts3.4/commands/GetLabelDetectionCommand.d.ts +2 -40
  117. package/dist-types/ts3.4/commands/GetPersonTrackingCommand.d.ts +2 -49
  118. package/dist-types/ts3.4/commands/GetSegmentDetectionCommand.d.ts +2 -42
  119. package/dist-types/ts3.4/commands/GetTextDetectionCommand.d.ts +2 -38
  120. package/dist-types/ts3.4/commands/IndexFacesCommand.d.ts +2 -119
  121. package/dist-types/ts3.4/commands/ListCollectionsCommand.d.ts +2 -25
  122. package/dist-types/ts3.4/commands/ListFacesCommand.d.ts +2 -27
  123. package/dist-types/ts3.4/commands/ListStreamProcessorsCommand.d.ts +2 -20
  124. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -24
  125. package/dist-types/ts3.4/commands/RecognizeCelebritiesCommand.d.ts +2 -50
  126. package/dist-types/ts3.4/commands/SearchFacesByImageCommand.d.ts +2 -66
  127. package/dist-types/ts3.4/commands/SearchFacesCommand.d.ts +2 -40
  128. package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +2 -31
  129. package/dist-types/ts3.4/commands/StartContentModerationCommand.d.ts +2 -31
  130. package/dist-types/ts3.4/commands/StartFaceDetectionCommand.d.ts +2 -32
  131. package/dist-types/ts3.4/commands/StartFaceSearchCommand.d.ts +2 -29
  132. package/dist-types/ts3.4/commands/StartLabelDetectionCommand.d.ts +2 -34
  133. package/dist-types/ts3.4/commands/StartPersonTrackingCommand.d.ts +2 -28
  134. package/dist-types/ts3.4/commands/StartProjectVersionCommand.d.ts +2 -29
  135. package/dist-types/ts3.4/commands/StartSegmentDetectionCommand.d.ts +2 -35
  136. package/dist-types/ts3.4/commands/StartStreamProcessorCommand.d.ts +2 -22
  137. package/dist-types/ts3.4/commands/StartTextDetectionCommand.d.ts +2 -27
  138. package/dist-types/ts3.4/commands/StopProjectVersionCommand.d.ts +2 -21
  139. package/dist-types/ts3.4/commands/StopStreamProcessorCommand.d.ts +2 -20
  140. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -24
  141. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -24
  142. package/dist-types/ts3.4/commands/index.d.ts +51 -0
  143. package/dist-types/ts3.4/index.d.ts +5 -69
  144. package/dist-types/ts3.4/models/models_0.d.ts +856 -3431
  145. package/dist-types/ts3.4/pagination/index.d.ts +14 -0
  146. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  147. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  148. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  149. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  150. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  151. package/dist-types/ts3.4/waiters/waitForProjectVersionRunning.d.ts +2 -9
  152. package/dist-types/ts3.4/waiters/waitForProjectVersionTrainingCompleted.d.ts +2 -9
  153. package/dist-types/waiters/index.d.ts +2 -0
  154. package/package.json +33 -33
@@ -5,35 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>
10
- * @example
11
- * Use a bare-bones client and the command you need to make an API call.
12
- * ```javascript
13
- * import { RekognitionClient, ListStreamProcessorsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
14
- * // const { RekognitionClient, ListStreamProcessorsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
15
- * const client = new RekognitionClient(config);
16
- * const command = new ListStreamProcessorsCommand(input);
17
- * const response = await client.send(command);
18
- * ```
19
- *
20
- * @see {@link ListStreamProcessorsCommandInput} for command's `input` shape.
21
- * @see {@link ListStreamProcessorsCommandOutput} for command's `response` shape.
22
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
23
- *
24
- */
25
8
  class ListStreamProcessorsCommand extends smithy_client_1.Command {
26
- // Start section: command_properties
27
- // End section: command_properties
28
9
  constructor(input) {
29
- // Start section: command_constructor
30
10
  super();
31
11
  this.input = input;
32
- // End section: command_constructor
33
12
  }
34
- /**
35
- * @internal
36
- */
37
13
  resolveMiddleware(clientStack, configuration, options) {
38
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
39
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,39 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>
10
- * Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
11
- * </p>
12
- * <p>This operation requires permissions to perform the
13
- * <code>rekognition:ListTagsForResource</code> action. </p>
14
- * @example
15
- * Use a bare-bones client and the command you need to make an API call.
16
- * ```javascript
17
- * import { RekognitionClient, ListTagsForResourceCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
18
- * // const { RekognitionClient, ListTagsForResourceCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
19
- * const client = new RekognitionClient(config);
20
- * const command = new ListTagsForResourceCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
25
- * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
26
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
29
8
  class ListTagsForResourceCommand extends smithy_client_1.Command {
30
- // Start section: command_properties
31
- // End section: command_properties
32
9
  constructor(input) {
33
- // Start section: command_constructor
34
10
  super();
35
11
  this.input = input;
36
- // End section: command_constructor
37
12
  }
38
- /**
39
- * @internal
40
- */
41
13
  resolveMiddleware(clientStack, configuration, options) {
42
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
43
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,65 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities
10
- * in the Amazon Rekognition Developer Guide. </p>
11
- * <p>
12
- * <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
13
- * recognized celebrities in the <code>CelebrityFaces</code> array and unrecognized faces in the
14
- * <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
15
- * celebrities whose faces aren't among the largest 64 faces in the image.</p>
16
- *
17
- * <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
18
- * <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity
19
- * name, ID, URL links to additional information, match confidence, and a
20
- * <code>ComparedFace</code> object that you can use to locate the celebrity's face on the
21
- * image.</p>
22
- * <p>Amazon Rekognition doesn't retain information about which images a celebrity has been recognized
23
- * in. Your application must store this information and use the <code>Celebrity</code> ID
24
- * property as a unique identifier for the celebrity. If you don't store the celebrity name or
25
- * additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the
26
- * ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a>
27
- * operation.</p>
28
- * <p>You pass the input image either as base64-encoded image bytes or as a reference to an
29
- * image in an Amazon S3 bucket. If you use the
30
- * AWS
31
- * CLI to call Amazon Rekognition operations, passing image bytes is not
32
- * supported. The image must be either a PNG or JPEG formatted file. </p>
33
- *
34
- *
35
- *
36
- *
37
- * <p>For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.</p>
38
- * <p>This operation requires permissions to perform the
39
- * <code>rekognition:RecognizeCelebrities</code> operation.</p>
40
- * @example
41
- * Use a bare-bones client and the command you need to make an API call.
42
- * ```javascript
43
- * import { RekognitionClient, RecognizeCelebritiesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
44
- * // const { RekognitionClient, RecognizeCelebritiesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
45
- * const client = new RekognitionClient(config);
46
- * const command = new RecognizeCelebritiesCommand(input);
47
- * const response = await client.send(command);
48
- * ```
49
- *
50
- * @see {@link RecognizeCelebritiesCommandInput} for command's `input` shape.
51
- * @see {@link RecognizeCelebritiesCommandOutput} for command's `response` shape.
52
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
53
- *
54
- */
55
8
  class RecognizeCelebritiesCommand extends smithy_client_1.Command {
56
- // Start section: command_properties
57
- // End section: command_properties
58
9
  constructor(input) {
59
- // Start section: command_constructor
60
10
  super();
61
11
  this.input = input;
62
- // End section: command_constructor
63
12
  }
64
- /**
65
- * @internal
66
- */
67
13
  resolveMiddleware(clientStack, configuration, options) {
68
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
69
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,81 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>For a given input image, first detects the largest face in the image, and then searches
10
- * the specified collection for matching faces. The operation compares the features of the input
11
- * face with faces in the specified collection. </p>
12
- * <note>
13
- * <p>To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent
14
- * calls to the <a>SearchFaces</a> operation. </p>
15
- * <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes
16
- * in the response to make face crops, which then you can pass in to the
17
- * <code>SearchFacesByImage</code> operation. </p>
18
- * </note>
19
- *
20
- * <p>You pass the input image either as base64-encoded image bytes or as a reference to an
21
- * image in an Amazon S3 bucket. If you use the
22
- * AWS
23
- * CLI to call Amazon Rekognition operations, passing image bytes is not
24
- * supported. The image must be either a PNG or JPEG formatted file. </p>
25
- * <p>
26
- * The response returns an array of faces that match, ordered by similarity score with the
27
- * highest similarity first. More specifically, it is an
28
- * array of metadata for each face match found. Along with the metadata, the response also
29
- * includes a <code>similarity</code> indicating how similar the face is
30
- * to the input face.
31
- *
32
- * In the response, the operation also returns the bounding
33
- * box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition
34
- * used for the input image.
35
- * </p>
36
- * <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
37
- * <code>InvalidParameterException</code> error. </p>
38
- *
39
- * <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.</p>
40
- *
41
- * <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
42
- * that don’t meet a required quality bar. The quality bar is based on a
43
- * variety of common use cases.
44
- * Use <code>QualityFilter</code> to set the quality bar for
45
- * filtering by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
46
- * If you do not want to filter detected faces, specify <code>NONE</code>. The default
47
- * value is <code>NONE</code>.</p>
48
- * <note>
49
- * <p>To use quality filtering, you need a collection associated with version 3 of the
50
- * face model or higher. To get the version of the face model associated with a collection, call
51
- * <a>DescribeCollection</a>. </p>
52
- * </note>
53
- *
54
- * <p>This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code>
55
- * action.</p>
56
- * @example
57
- * Use a bare-bones client and the command you need to make an API call.
58
- * ```javascript
59
- * import { RekognitionClient, SearchFacesByImageCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
60
- * // const { RekognitionClient, SearchFacesByImageCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
61
- * const client = new RekognitionClient(config);
62
- * const command = new SearchFacesByImageCommand(input);
63
- * const response = await client.send(command);
64
- * ```
65
- *
66
- * @see {@link SearchFacesByImageCommandInput} for command's `input` shape.
67
- * @see {@link SearchFacesByImageCommandOutput} for command's `response` shape.
68
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
69
- *
70
- */
71
8
  class SearchFacesByImageCommand extends smithy_client_1.Command {
72
- // Start section: command_properties
73
- // End section: command_properties
74
9
  constructor(input) {
75
- // Start section: command_constructor
76
10
  super();
77
11
  this.input = input;
78
- // End section: command_constructor
79
12
  }
80
- /**
81
- * @internal
82
- */
83
13
  resolveMiddleware(clientStack, configuration, options) {
84
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
85
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,55 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>For a given input face ID, searches for matching faces in the collection the face
10
- * belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with
11
- * faces in the specified collection. </p>
12
- * <note>
13
- * <p>You can also search faces without indexing faces by using the
14
- * <code>SearchFacesByImage</code> operation.</p>
15
- * </note>
16
- *
17
- * <p>
18
- * The operation response returns
19
- * an array of faces that match, ordered by similarity score with the highest
20
- * similarity first. More specifically, it is an
21
- * array of metadata for each face match that is found. Along with the metadata, the response also
22
- * includes a <code>confidence</code> value for each face match, indicating the confidence
23
- * that the specific face matches the input face.
24
- * </p>
25
- *
26
- * <p>For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.</p>
27
- *
28
- * <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
29
- * action.</p>
30
- * @example
31
- * Use a bare-bones client and the command you need to make an API call.
32
- * ```javascript
33
- * import { RekognitionClient, SearchFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
34
- * // const { RekognitionClient, SearchFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
35
- * const client = new RekognitionClient(config);
36
- * const command = new SearchFacesCommand(input);
37
- * const response = await client.send(command);
38
- * ```
39
- *
40
- * @see {@link SearchFacesCommandInput} for command's `input` shape.
41
- * @see {@link SearchFacesCommandOutput} for command's `response` shape.
42
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
43
- *
44
- */
45
8
  class SearchFacesCommand extends smithy_client_1.Command {
46
- // Start section: command_properties
47
- // End section: command_properties
48
9
  constructor(input) {
49
- // Start section: command_constructor
50
10
  super();
51
11
  this.input = input;
52
- // End section: command_constructor
53
12
  }
54
- /**
55
- * @internal
56
- */
57
13
  resolveMiddleware(clientStack, configuration, options) {
58
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
59
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,46 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts asynchronous recognition of celebrities in a stored video.</p>
10
- * <p>Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
11
- * and the filename of the video.
12
- * <code>StartCelebrityRecognition</code>
13
- * returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
14
- * When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status
15
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
16
- * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
17
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
19
- *
20
- * <p>For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.</p>
21
- * @example
22
- * Use a bare-bones client and the command you need to make an API call.
23
- * ```javascript
24
- * import { RekognitionClient, StartCelebrityRecognitionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
25
- * // const { RekognitionClient, StartCelebrityRecognitionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
26
- * const client = new RekognitionClient(config);
27
- * const command = new StartCelebrityRecognitionCommand(input);
28
- * const response = await client.send(command);
29
- * ```
30
- *
31
- * @see {@link StartCelebrityRecognitionCommandInput} for command's `input` shape.
32
- * @see {@link StartCelebrityRecognitionCommandOutput} for command's `response` shape.
33
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
34
- *
35
- */
36
8
  class StartCelebrityRecognitionCommand extends smithy_client_1.Command {
37
- // Start section: command_properties
38
- // End section: command_properties
39
9
  constructor(input) {
40
- // Start section: command_constructor
41
10
  super();
42
11
  this.input = input;
43
- // End section: command_constructor
44
12
  }
45
- /**
46
- * @internal
47
- */
48
13
  resolveMiddleware(clientStack, configuration, options) {
49
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
50
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,46 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p> Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see
10
- * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
11
- * <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
12
- * and the filename of the video. <code>StartContentModeration</code>
13
- * returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
14
- * When content analysis is finished, Amazon Rekognition Video publishes a completion status
15
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
16
- * <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
17
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
19
- *
20
- * <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>
21
- * @example
22
- * Use a bare-bones client and the command you need to make an API call.
23
- * ```javascript
24
- * import { RekognitionClient, StartContentModerationCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
25
- * // const { RekognitionClient, StartContentModerationCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
26
- * const client = new RekognitionClient(config);
27
- * const command = new StartContentModerationCommand(input);
28
- * const response = await client.send(command);
29
- * ```
30
- *
31
- * @see {@link StartContentModerationCommandInput} for command's `input` shape.
32
- * @see {@link StartContentModerationCommandOutput} for command's `response` shape.
33
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
34
- *
35
- */
36
8
  class StartContentModerationCommand extends smithy_client_1.Command {
37
- // Start section: command_properties
38
- // End section: command_properties
39
9
  constructor(input) {
40
- // Start section: command_constructor
41
10
  super();
42
11
  this.input = input;
43
- // End section: command_constructor
44
12
  }
45
- /**
46
- * @internal
47
- */
48
13
  resolveMiddleware(clientStack, configuration, options) {
49
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
50
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,47 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts asynchronous detection of faces in a stored video.</p>
10
- * <p>Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.
11
- * Use <a>Video</a> to specify the bucket name and the filename of the video.
12
- * <code>StartFaceDetection</code> returns a job identifier (<code>JobId</code>) that you
13
- * use to get the results of the operation.
14
- * When face detection is finished, Amazon Rekognition Video publishes a completion status
15
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
16
- * To get the results of the face detection operation, first check that the status value published to the Amazon SNS
17
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
19
- *
20
- * <p>For more information, see Detecting Faces in a Stored Video in the
21
- * Amazon Rekognition Developer Guide.</p>
22
- * @example
23
- * Use a bare-bones client and the command you need to make an API call.
24
- * ```javascript
25
- * import { RekognitionClient, StartFaceDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
26
- * // const { RekognitionClient, StartFaceDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
27
- * const client = new RekognitionClient(config);
28
- * const command = new StartFaceDetectionCommand(input);
29
- * const response = await client.send(command);
30
- * ```
31
- *
32
- * @see {@link StartFaceDetectionCommandInput} for command's `input` shape.
33
- * @see {@link StartFaceDetectionCommandOutput} for command's `response` shape.
34
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
35
- *
36
- */
37
8
  class StartFaceDetectionCommand extends smithy_client_1.Command {
38
- // Start section: command_properties
39
- // End section: command_properties
40
9
  constructor(input) {
41
- // Start section: command_constructor
42
10
  super();
43
11
  this.input = input;
44
- // End section: command_constructor
45
12
  }
46
- /**
47
- * @internal
48
- */
49
13
  resolveMiddleware(clientStack, configuration, options) {
50
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
51
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,44 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>
10
- * <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
11
- * and the filename of the video. <code>StartFaceSearch</code>
12
- * returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed.
13
- * When searching is finished, Amazon Rekognition Video publishes a completion status
14
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
15
- * To get the search results, first check that the status value published to the Amazon SNS
16
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier
17
- * (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see
18
- * <a>procedure-person-search-videos</a>.</p>
19
- * @example
20
- * Use a bare-bones client and the command you need to make an API call.
21
- * ```javascript
22
- * import { RekognitionClient, StartFaceSearchCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
23
- * // const { RekognitionClient, StartFaceSearchCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
24
- * const client = new RekognitionClient(config);
25
- * const command = new StartFaceSearchCommand(input);
26
- * const response = await client.send(command);
27
- * ```
28
- *
29
- * @see {@link StartFaceSearchCommandInput} for command's `input` shape.
30
- * @see {@link StartFaceSearchCommandOutput} for command's `response` shape.
31
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
32
- *
33
- */
34
8
  class StartFaceSearchCommand extends smithy_client_1.Command {
35
- // Start section: command_properties
36
- // End section: command_properties
37
9
  constructor(input) {
38
- // Start section: command_constructor
39
10
  super();
40
11
  this.input = input;
41
- // End section: command_constructor
42
12
  }
43
- /**
44
- * @internal
45
- */
46
13
  resolveMiddleware(clientStack, configuration, options) {
47
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
48
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,49 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts asynchronous detection of labels in a stored video.</p>
10
- * <p>Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.
11
- * This includes objects like flower, tree, and table; events like
12
- * wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities
13
- * like a person getting out of a car or a person skiing.</p>
14
- *
15
- * <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
16
- * and the filename of the video.
17
- * <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the
18
- * results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status
19
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
20
- * <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS
21
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier
22
- * (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
23
- * <p></p>
24
- * @example
25
- * Use a bare-bones client and the command you need to make an API call.
26
- * ```javascript
27
- * import { RekognitionClient, StartLabelDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
28
- * // const { RekognitionClient, StartLabelDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
29
- * const client = new RekognitionClient(config);
30
- * const command = new StartLabelDetectionCommand(input);
31
- * const response = await client.send(command);
32
- * ```
33
- *
34
- * @see {@link StartLabelDetectionCommandInput} for command's `input` shape.
35
- * @see {@link StartLabelDetectionCommandOutput} for command's `response` shape.
36
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
37
- *
38
- */
39
8
  class StartLabelDetectionCommand extends smithy_client_1.Command {
40
- // Start section: command_properties
41
- // End section: command_properties
42
9
  constructor(input) {
43
- // Start section: command_constructor
44
10
  super();
45
11
  this.input = input;
46
- // End section: command_constructor
47
12
  }
48
- /**
49
- * @internal
50
- */
51
13
  resolveMiddleware(clientStack, configuration, options) {
52
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
53
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,43 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
10
- * <p>Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
11
- * and the filename of the video. <code>StartPersonTracking</code>
12
- * returns a job identifier (<code>JobId</code>) which you use to get the results of the operation.
13
- * When label detection is finished, Amazon Rekognition publishes a completion status
14
- * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </p>
15
- * <p>To get the results of the person detection operation, first check that the status value published to the Amazon SNS
16
- * topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier
17
- * (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>
18
- * @example
19
- * Use a bare-bones client and the command you need to make an API call.
20
- * ```javascript
21
- * import { RekognitionClient, StartPersonTrackingCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
22
- * // const { RekognitionClient, StartPersonTrackingCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
23
- * const client = new RekognitionClient(config);
24
- * const command = new StartPersonTrackingCommand(input);
25
- * const response = await client.send(command);
26
- * ```
27
- *
28
- * @see {@link StartPersonTrackingCommandInput} for command's `input` shape.
29
- * @see {@link StartPersonTrackingCommandOutput} for command's `response` shape.
30
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
31
- *
32
- */
33
8
  class StartPersonTrackingCommand extends smithy_client_1.Command {
34
- // Start section: command_properties
35
- // End section: command_properties
36
9
  constructor(input) {
37
- // Start section: command_constructor
38
10
  super();
39
11
  this.input = input;
40
- // End section: command_constructor
41
12
  }
42
- /**
43
- * @internal
44
- */
45
13
  resolveMiddleware(clientStack, configuration, options) {
46
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
47
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,44 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
5
5
  const smithy_client_1 = require("@aws-sdk/smithy-client");
6
6
  const models_0_1 = require("../models/models_0");
7
7
  const Aws_json1_1_1 = require("../protocols/Aws_json1_1");
8
- /**
9
- * <p>Starts the running of the version of a model. Starting a model takes a while
10
- * to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>
11
- * <p>Once the model is running, you can detect custom labels in new images by calling
12
- * <a>DetectCustomLabels</a>.</p>
13
- * <note>
14
- * <p>You are charged for the amount of time that the model is running. To stop a running
15
- * model, call <a>StopProjectVersion</a>.</p>
16
- * </note>
17
- * <p>This operation requires permissions to perform the
18
- * <code>rekognition:StartProjectVersion</code> action.</p>
19
- * @example
20
- * Use a bare-bones client and the command you need to make an API call.
21
- * ```javascript
22
- * import { RekognitionClient, StartProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
23
- * // const { RekognitionClient, StartProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
24
- * const client = new RekognitionClient(config);
25
- * const command = new StartProjectVersionCommand(input);
26
- * const response = await client.send(command);
27
- * ```
28
- *
29
- * @see {@link StartProjectVersionCommandInput} for command's `input` shape.
30
- * @see {@link StartProjectVersionCommandOutput} for command's `response` shape.
31
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
32
- *
33
- */
34
8
  class StartProjectVersionCommand extends smithy_client_1.Command {
35
- // Start section: command_properties
36
- // End section: command_properties
37
9
  constructor(input) {
38
- // Start section: command_constructor
39
10
  super();
40
11
  this.input = input;
41
- // End section: command_constructor
42
12
  }
43
- /**
44
- * @internal
45
- */
46
13
  resolveMiddleware(clientStack, configuration, options) {
47
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
48
15
  const stack = clientStack.concat(this.middlewareStack);