@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
package/CHANGELOG.md CHANGED
@@ -3,6 +3,48 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.39.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.38.0...v3.39.0) (2021-10-29)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-rekognition
9
+
10
+
11
+
12
+
13
+
14
+ # [3.38.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.37.0...v3.38.0) (2021-10-22)
15
+
16
+
17
+ ### Features
18
+
19
+ * **client-documentation-generator:** rename package ([#2916](https://github.com/aws/aws-sdk-js-v3/issues/2916)) ([1a80bfd](https://github.com/aws/aws-sdk-js-v3/commit/1a80bfd2dfc583001ddb4a21b6432eaaad699aa7))
20
+ * **clients:** export folder from index.ts ([#2912](https://github.com/aws/aws-sdk-js-v3/issues/2912)) ([183b46d](https://github.com/aws/aws-sdk-js-v3/commit/183b46dde7f5613128038bf1c076f3c0b693203b))
21
+
22
+
23
+
24
+
25
+
26
+ # [3.37.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.1...v3.37.0) (2021-10-15)
27
+
28
+
29
+ ### Features
30
+
31
+ * **clients:** update clients as of 10/15/2021 ([#2902](https://github.com/aws/aws-sdk-js-v3/issues/2902)) ([2730b54](https://github.com/aws/aws-sdk-js-v3/commit/2730b5424377944a5a2ad5e1ad7d3ca4135dae1c))
32
+
33
+
34
+
35
+
36
+
37
+ ## [3.36.1](https://github.com/aws/aws-sdk-js-v3/compare/v3.36.0...v3.36.1) (2021-10-12)
38
+
39
+
40
+ ### Bug Fixes
41
+
42
+ * **clients:** emitDeclarationOnly in tsconfig.types.json ([#2893](https://github.com/aws/aws-sdk-js-v3/issues/2893)) ([6dc3d56](https://github.com/aws/aws-sdk-js-v3/commit/6dc3d56c20809c90cbdc4dd48627eeebc64af99d))
43
+
44
+
45
+
46
+
47
+
6
48
  # [3.36.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.35.0...v3.36.0) (2021-10-08)
7
49
 
8
50
 
@@ -53,9 +53,6 @@ const StopStreamProcessorCommand_1 = require("./commands/StopStreamProcessorComm
53
53
  const TagResourceCommand_1 = require("./commands/TagResourceCommand");
54
54
  const UntagResourceCommand_1 = require("./commands/UntagResourceCommand");
55
55
  const RekognitionClient_1 = require("./RekognitionClient");
56
- /**
57
- * <p>This is the Amazon Rekognition API reference.</p>
58
- */
59
56
  class Rekognition extends RekognitionClient_1.RekognitionClient {
60
57
  compareFaces(args, optionsOrCb, cb) {
61
58
  const command = new CompareFacesCommand_1.CompareFacesCommand(args);
@@ -10,9 +10,6 @@ const middleware_signing_1 = require("@aws-sdk/middleware-signing");
10
10
  const middleware_user_agent_1 = require("@aws-sdk/middleware-user-agent");
11
11
  const smithy_client_1 = require("@aws-sdk/smithy-client");
12
12
  const runtimeConfig_1 = require("./runtimeConfig");
13
- /**
14
- * <p>This is the Amazon Rekognition API reference.</p>
15
- */
16
13
  class RekognitionClient extends smithy_client_1.Client {
17
14
  constructor(configuration) {
18
15
  const _config_0 = runtimeConfig_1.getRuntimeConfig(configuration);
@@ -31,11 +28,6 @@ class RekognitionClient extends smithy_client_1.Client {
31
28
  this.middlewareStack.use(middleware_signing_1.getAwsAuthPlugin(this.config));
32
29
  this.middlewareStack.use(middleware_user_agent_1.getUserAgentPlugin(this.config));
33
30
  }
34
- /**
35
- * Destroy underlying resources, like sockets. It's usually not necessary to do this.
36
- * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
37
- * Otherwise, sockets might stay open for quite a long time before the server terminates them.
38
- */
39
31
  destroy() {
40
32
  super.destroy();
41
33
  }
@@ -5,97 +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>Compares a face in the <i>source</i> input image with
10
- * each of the 100 largest faces detected in the <i>target</i> input image.
11
- * </p>
12
- *
13
- * <p> If the source image contains multiple faces, the service detects the largest face
14
- * and compares it with each face detected in the target image. </p>
15
- *
16
- *
17
- * <note>
18
- * <p>CompareFaces uses machine learning algorithms, which are probabilistic.
19
- * A false negative is an incorrect prediction that
20
- * a face in the target image has a low similarity confidence score when compared to the face
21
- * in the source image. To reduce the probability of false negatives,
22
- * we recommend that you compare the target image against multiple source images.
23
- * If you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's rights,
24
- * privacy, or access to services, we recommend that you pass the result to a human for review and further
25
- * validation before taking action.</p>
26
- * </note>
27
- *
28
- *
29
- * <p>You pass the input and target images either as base64-encoded image bytes or as
30
- * references to images in an Amazon S3 bucket. If you use the
31
- * AWS
32
- * CLI to call Amazon Rekognition operations, passing image bytes isn't
33
- * supported. The image must be formatted as a PNG or JPEG file. </p>
34
- * <p>In response, the operation returns an array of face matches ordered by similarity score
35
- * in descending order. For each face match, the response provides a bounding box of the face,
36
- * facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and
37
- * confidence value (indicating the level of confidence that the bounding box contains a face).
38
- * The response also provides a similarity score, which indicates how closely the faces match. </p>
39
- *
40
- * <note>
41
- * <p>By default, only faces with a similarity score of greater than or equal to 80% are
42
- * returned in the response. You can change this value by specifying the
43
- * <code>SimilarityThreshold</code> parameter.</p>
44
- * </note>
45
- *
46
- * <p>
47
- * <code>CompareFaces</code> also returns an array of faces that don't match the source image.
48
- * For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.
49
- * The response also returns information about the face in the source image, including the bounding box
50
- * of the face and confidence value.</p>
51
- *
52
- * <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
53
- * that don’t meet a required quality bar. The quality bar is based on a
54
- * variety of common use cases. Use <code>QualityFilter</code> to set the quality bar
55
- * by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
56
- * If you do not want to filter detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
57
- *
58
- * <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the
59
- * source and target images. Use these values to display the images with the correct image orientation.</p>
60
- * <p>If no faces are detected in the source or target images, <code>CompareFaces</code> returns an
61
- * <code>InvalidParameterException</code> error. </p>
62
- *
63
- *
64
- * <note>
65
- * <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p>
66
- * </note>
67
- *
68
- *
69
- * <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.</p>
70
- * <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code>
71
- * action.</p>
72
- * @example
73
- * Use a bare-bones client and the command you need to make an API call.
74
- * ```javascript
75
- * import { RekognitionClient, CompareFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
76
- * // const { RekognitionClient, CompareFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
77
- * const client = new RekognitionClient(config);
78
- * const command = new CompareFacesCommand(input);
79
- * const response = await client.send(command);
80
- * ```
81
- *
82
- * @see {@link CompareFacesCommandInput} for command's `input` shape.
83
- * @see {@link CompareFacesCommandOutput} for command's `response` shape.
84
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
85
- *
86
- */
87
8
  class CompareFacesCommand extends smithy_client_1.Command {
88
- // Start section: command_properties
89
- // End section: command_properties
90
9
  constructor(input) {
91
- // Start section: command_constructor
92
10
  super();
93
11
  this.input = input;
94
- // End section: command_constructor
95
12
  }
96
- /**
97
- * @internal
98
- */
99
13
  resolveMiddleware(clientStack, configuration, options) {
100
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
101
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>Creates a collection in an AWS Region. You can add faces to the collection using the
10
- * <a>IndexFaces</a> operation. </p>
11
- * <p>For example, you might create collections, one for each of your application users. A
12
- * user can then index faces using the <code>IndexFaces</code> operation and persist results in a
13
- * specific collection. Then, a user can search the collection for faces in the user-specific
14
- * container. </p>
15
- * <p>When you create a collection, it is associated with the latest version of the face model version.</p>
16
- * <note>
17
- * <p>Collection names are case-sensitive.</p>
18
- * </note>
19
- *
20
- * <p>This operation requires permissions to perform the
21
- * <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
22
- * @example
23
- * Use a bare-bones client and the command you need to make an API call.
24
- * ```javascript
25
- * import { RekognitionClient, CreateCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
26
- * // const { RekognitionClient, CreateCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
27
- * const client = new RekognitionClient(config);
28
- * const command = new CreateCollectionCommand(input);
29
- * const response = await client.send(command);
30
- * ```
31
- *
32
- * @see {@link CreateCollectionCommandInput} for command's `input` shape.
33
- * @see {@link CreateCollectionCommandOutput} for command's `response` shape.
34
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
35
- *
36
- */
37
8
  class CreateCollectionCommand 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,37 +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>Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models)
10
- * and operations (training, evaluation and detection). </p>
11
- * <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
12
- * @example
13
- * Use a bare-bones client and the command you need to make an API call.
14
- * ```javascript
15
- * import { RekognitionClient, CreateProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
16
- * // const { RekognitionClient, CreateProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
17
- * const client = new RekognitionClient(config);
18
- * const command = new CreateProjectCommand(input);
19
- * const response = await client.send(command);
20
- * ```
21
- *
22
- * @see {@link CreateProjectCommandInput} for command's `input` shape.
23
- * @see {@link CreateProjectCommandOutput} for command's `response` shape.
24
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
25
- *
26
- */
27
8
  class CreateProjectCommand extends smithy_client_1.Command {
28
- // Start section: command_properties
29
- // End section: command_properties
30
9
  constructor(input) {
31
- // Start section: command_constructor
32
10
  super();
33
11
  this.input = input;
34
- // End section: command_constructor
35
12
  }
36
- /**
37
- * @internal
38
- */
39
13
  resolveMiddleware(clientStack, configuration, options) {
40
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
41
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>Creates a new version of a model and begins training.
10
- * Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify
11
- * one training dataset and one testing dataset. The response from <code>CreateProjectVersion</code>
12
- * is an Amazon Resource Name (ARN) for the version of the model. </p>
13
- * <p>Training takes a while to complete. You can get the current status by calling
14
- * <a>DescribeProjectVersions</a>.</p>
15
- * <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
16
- * get the training results and evaluate the model.
17
- * </p>
18
- * <p>After evaluating the model, you start the model
19
- * by calling <a>StartProjectVersion</a>.</p>
20
- * <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
21
- * @example
22
- * Use a bare-bones client and the command you need to make an API call.
23
- * ```javascript
24
- * import { RekognitionClient, CreateProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
25
- * // const { RekognitionClient, CreateProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
26
- * const client = new RekognitionClient(config);
27
- * const command = new CreateProjectVersionCommand(input);
28
- * const response = await client.send(command);
29
- * ```
30
- *
31
- * @see {@link CreateProjectVersionCommandInput} for command's `input` shape.
32
- * @see {@link CreateProjectVersionCommandOutput} for command's `response` shape.
33
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
34
- *
35
- */
36
8
  class CreateProjectVersionCommand 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,45 +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>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>
10
- * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.</p>
11
- * <p>You provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
12
- * face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize.
13
- * Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
14
- * to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
15
- * the <code>Name</code> field. </p>
16
- * <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
17
- * stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>
18
- * <p>This operation requires permissions to perform the
19
- * <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>
20
- * @example
21
- * Use a bare-bones client and the command you need to make an API call.
22
- * ```javascript
23
- * import { RekognitionClient, CreateStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
24
- * // const { RekognitionClient, CreateStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
25
- * const client = new RekognitionClient(config);
26
- * const command = new CreateStreamProcessorCommand(input);
27
- * const response = await client.send(command);
28
- * ```
29
- *
30
- * @see {@link CreateStreamProcessorCommandInput} for command's `input` shape.
31
- * @see {@link CreateStreamProcessorCommandOutput} for command's `response` shape.
32
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
33
- *
34
- */
35
8
  class CreateStreamProcessorCommand extends smithy_client_1.Command {
36
- // Start section: command_properties
37
- // End section: command_properties
38
9
  constructor(input) {
39
- // Start section: command_constructor
40
10
  super();
41
11
  this.input = input;
42
- // End section: command_constructor
43
12
  }
44
- /**
45
- * @internal
46
- */
47
13
  resolveMiddleware(clientStack, configuration, options) {
48
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
49
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>Deletes the specified collection. Note that this operation
10
- * removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>.</p>
11
- *
12
- * <p>This operation requires permissions to perform the
13
- * <code>rekognition:DeleteCollection</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, DeleteCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
18
- * // const { RekognitionClient, DeleteCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
19
- * const client = new RekognitionClient(config);
20
- * const command = new DeleteCollectionCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link DeleteCollectionCommandInput} for command's `input` shape.
25
- * @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
26
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
29
8
  class DeleteCollectionCommand 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,38 +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>Deletes faces from a collection. You specify a collection ID and an array of face IDs
10
- * to remove from the collection.</p>
11
- * <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
12
- * action.</p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { RekognitionClient, DeleteFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
17
- * // const { RekognitionClient, DeleteFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
18
- * const client = new RekognitionClient(config);
19
- * const command = new DeleteFacesCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link DeleteFacesCommandInput} for command's `input` shape.
24
- * @see {@link DeleteFacesCommandOutput} for command's `response` shape.
25
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
28
8
  class DeleteFacesCommand extends smithy_client_1.Command {
29
- // Start section: command_properties
30
- // End section: command_properties
31
9
  constructor(input) {
32
- // Start section: command_constructor
33
10
  super();
34
11
  this.input = input;
35
- // End section: command_constructor
36
12
  }
37
- /**
38
- * @internal
39
- */
40
13
  resolveMiddleware(clientStack, configuration, options) {
41
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
42
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,38 +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>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
10
- * with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
11
- * <p>This operation requires permissions to perform the
12
- * <code>rekognition:DeleteProject</code> action. </p>
13
- * @example
14
- * Use a bare-bones client and the command you need to make an API call.
15
- * ```javascript
16
- * import { RekognitionClient, DeleteProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
17
- * // const { RekognitionClient, DeleteProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
18
- * const client = new RekognitionClient(config);
19
- * const command = new DeleteProjectCommand(input);
20
- * const response = await client.send(command);
21
- * ```
22
- *
23
- * @see {@link DeleteProjectCommandInput} for command's `input` shape.
24
- * @see {@link DeleteProjectCommandOutput} for command's `response` shape.
25
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
26
- *
27
- */
28
8
  class DeleteProjectCommand extends smithy_client_1.Command {
29
- // Start section: command_properties
30
- // End section: command_properties
31
9
  constructor(input) {
32
- // Start section: command_constructor
33
10
  super();
34
11
  this.input = input;
35
- // End section: command_constructor
36
12
  }
37
- /**
38
- * @internal
39
- */
40
13
  resolveMiddleware(clientStack, configuration, options) {
41
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
42
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,42 +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>Deletes an Amazon Rekognition Custom Labels model. </p>
10
- * <p>You can't delete a model if it is running or if it is training.
11
- * To check the status of a model, use the <code>Status</code> field returned
12
- * from <a>DescribeProjectVersions</a>.
13
- * To stop a running model call <a>StopProjectVersion</a>. If the model
14
- * is training, wait until it finishes.</p>
15
- * <p>This operation requires permissions to perform the
16
- * <code>rekognition:DeleteProjectVersion</code> action. </p>
17
- * @example
18
- * Use a bare-bones client and the command you need to make an API call.
19
- * ```javascript
20
- * import { RekognitionClient, DeleteProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
21
- * // const { RekognitionClient, DeleteProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
22
- * const client = new RekognitionClient(config);
23
- * const command = new DeleteProjectVersionCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link DeleteProjectVersionCommandInput} for command's `input` shape.
28
- * @see {@link DeleteProjectVersionCommandOutput} for command's `response` shape.
29
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
32
8
  class DeleteProjectVersionCommand extends smithy_client_1.Command {
33
- // Start section: command_properties
34
- // End section: command_properties
35
9
  constructor(input) {
36
- // Start section: command_constructor
37
10
  super();
38
11
  this.input = input;
39
- // End section: command_constructor
40
12
  }
41
- /**
42
- * @internal
43
- */
44
13
  resolveMiddleware(clientStack, configuration, options) {
45
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
46
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,36 +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>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with
10
- * <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { RekognitionClient, DeleteStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
15
- * // const { RekognitionClient, DeleteStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
16
- * const client = new RekognitionClient(config);
17
- * const command = new DeleteStreamProcessorCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link DeleteStreamProcessorCommandInput} for command's `input` shape.
22
- * @see {@link DeleteStreamProcessorCommandOutput} for command's `response` shape.
23
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class DeleteStreamProcessorCommand extends smithy_client_1.Command {
27
- // Start section: command_properties
28
- // End section: command_properties
29
9
  constructor(input) {
30
- // Start section: command_constructor
31
10
  super();
32
11
  this.input = input;
33
- // End section: command_constructor
34
12
  }
35
- /**
36
- * @internal
37
- */
38
13
  resolveMiddleware(clientStack, configuration, options) {
39
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
40
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,40 +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>Describes the specified collection. You can use <code>DescribeCollection</code> to get
10
- * information, such as the number of faces indexed into a collection and the version of the
11
- * model used by the collection for face detection.</p>
12
- *
13
- * <p>For more information, see Describing a Collection in the
14
- * Amazon Rekognition Developer Guide.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { RekognitionClient, DescribeCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
19
- * // const { RekognitionClient, DescribeCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
20
- * const client = new RekognitionClient(config);
21
- * const command = new DescribeCollectionCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link DescribeCollectionCommandInput} for command's `input` shape.
26
- * @see {@link DescribeCollectionCommandOutput} for command's `response` shape.
27
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
30
8
  class DescribeCollectionCommand extends smithy_client_1.Command {
31
- // Start section: command_properties
32
- // End section: command_properties
33
9
  constructor(input) {
34
- // Start section: command_constructor
35
10
  super();
36
11
  this.input = input;
37
- // End section: command_constructor
38
12
  }
39
- /**
40
- * @internal
41
- */
42
13
  resolveMiddleware(clientStack, configuration, options) {
43
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
44
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>Lists and describes the models in an Amazon Rekognition Custom Labels project. You
10
- * can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
11
- * you don't specify a value, descriptions for all models are returned.</p>
12
- * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>
13
- * 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, DescribeProjectVersionsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
18
- * // const { RekognitionClient, DescribeProjectVersionsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
19
- * const client = new RekognitionClient(config);
20
- * const command = new DescribeProjectVersionsCommand(input);
21
- * const response = await client.send(command);
22
- * ```
23
- *
24
- * @see {@link DescribeProjectVersionsCommandInput} for command's `input` shape.
25
- * @see {@link DescribeProjectVersionsCommandOutput} for command's `response` shape.
26
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
27
- *
28
- */
29
8
  class DescribeProjectVersionsCommand 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);