@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,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>Lists and gets information about your Amazon Rekognition Custom Labels projects.</p>
10
- * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { RekognitionClient, DescribeProjectsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
15
- * // const { RekognitionClient, DescribeProjectsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
16
- * const client = new RekognitionClient(config);
17
- * const command = new DescribeProjectsCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link DescribeProjectsCommandInput} for command's `input` shape.
22
- * @see {@link DescribeProjectsCommandOutput} for command's `response` shape.
23
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class DescribeProjectsCommand 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,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>Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed,
10
- * and the current status of the stream processor.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { RekognitionClient, DescribeStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
15
- * // const { RekognitionClient, DescribeStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
16
- * const client = new RekognitionClient(config);
17
- * const command = new DescribeStreamProcessorCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link DescribeStreamProcessorCommandInput} for command's `input` shape.
22
- * @see {@link DescribeStreamProcessorCommandOutput} for command's `response` shape.
23
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
26
8
  class DescribeStreamProcessorCommand 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,85 +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>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
10
- * <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
11
- * parameter. </p>
12
- * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
13
- * an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
14
- * image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
15
- * <p> For each object that the model version detects on an image, the API returns a
16
- * (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).
17
- * Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
18
- * of confidence that the image contains the object (<code>Confidence</code>), and
19
- * object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
20
- *
21
- *
22
- *
23
- *
24
- *
25
- *
26
- *
27
- *
28
- *
29
- *
30
- * <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
31
- * <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
32
- * the specified value.
33
- *
34
- * The value of <code>MinConfidence</code> maps to the assumed threshold values
35
- * created during training. For more information, see <i>Assumed threshold</i>
36
- * in the Amazon Rekognition Custom Labels Developer Guide.
37
- * Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of
38
- * <code>MinConfidence</code> normalizes the threshold value to a percentage value (0-100). Confidence
39
- * responses from <code>DetectCustomLabels</code> are also returned as a percentage.
40
- * You can use <code>MinConfidence</code> to change the precision and recall or your model.
41
- * For more information, see
42
- * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
43
- *
44
- * <p>If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code>
45
- * returns labels based on the assumed threshold of each label.</p>
46
- *
47
- *
48
- *
49
- *
50
- *
51
- * <p>This is a stateless API operation. That is, the operation does not persist any
52
- * data.</p>
53
- * <p>This operation requires permissions to perform the
54
- * <code>rekognition:DetectCustomLabels</code> action. </p>
55
- *
56
- *
57
- *
58
- * <p>For more information, see
59
- * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
60
- * @example
61
- * Use a bare-bones client and the command you need to make an API call.
62
- * ```javascript
63
- * import { RekognitionClient, DetectCustomLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
64
- * // const { RekognitionClient, DetectCustomLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
65
- * const client = new RekognitionClient(config);
66
- * const command = new DetectCustomLabelsCommand(input);
67
- * const response = await client.send(command);
68
- * ```
69
- *
70
- * @see {@link DetectCustomLabelsCommandInput} for command's `input` shape.
71
- * @see {@link DetectCustomLabelsCommandOutput} for command's `response` shape.
72
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
73
- *
74
- */
75
8
  class DetectCustomLabelsCommand extends smithy_client_1.Command {
76
- // Start section: command_properties
77
- // End section: command_properties
78
9
  constructor(input) {
79
- // Start section: command_constructor
80
10
  super();
81
11
  this.input = input;
82
- // End section: command_constructor
83
12
  }
84
- /**
85
- * @internal
86
- */
87
13
  resolveMiddleware(clientStack, configuration, options) {
88
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
89
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,57 +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>Detects faces within an image that is provided as input.</p>
10
- *
11
- * <p>
12
- * <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
13
- * detected, the operation returns face details. These details include a bounding box of the
14
- * face, a confidence value (that the bounding box contains a face), and a fixed set of
15
- * attributes such as facial landmarks (for example, coordinates of eye and mouth),
16
- * presence of beard, sunglasses, and so on. </p>
17
- * <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
18
- * obscured faces, the algorithm might not detect the faces or might detect faces with lower
19
- * confidence. </p>
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 AWS CLI
22
- * to call Amazon Rekognition operations, passing image bytes is not
23
- * supported. The image must be either a PNG or JPEG formatted file. </p>
24
- *
25
- * <note>
26
- * <p>This is a stateless API operation. That is, the operation does not persist any
27
- * data.</p>
28
- * </note>
29
- *
30
- * <p>This operation requires permissions to perform the
31
- * <code>rekognition:DetectFaces</code> action. </p>
32
- * @example
33
- * Use a bare-bones client and the command you need to make an API call.
34
- * ```javascript
35
- * import { RekognitionClient, DetectFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
36
- * // const { RekognitionClient, DetectFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
37
- * const client = new RekognitionClient(config);
38
- * const command = new DetectFacesCommand(input);
39
- * const response = await client.send(command);
40
- * ```
41
- *
42
- * @see {@link DetectFacesCommandInput} for command's `input` shape.
43
- * @see {@link DetectFacesCommandOutput} for command's `response` shape.
44
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
45
- *
46
- */
47
8
  class DetectFacesCommand extends smithy_client_1.Command {
48
- // Start section: command_properties
49
- // End section: command_properties
50
9
  constructor(input) {
51
- // Start section: command_constructor
52
10
  super();
53
11
  this.input = input;
54
- // End section: command_constructor
55
12
  }
56
- /**
57
- * @internal
58
- */
59
13
  resolveMiddleware(clientStack, configuration, options) {
60
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
61
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,107 +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>Detects instances of real-world entities within an image (JPEG or PNG)
10
- * provided as input. This includes objects like flower, tree, and table; events like
11
- * wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
12
- * </p>
13
- *
14
- * <p>For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.</p>
15
- * <note>
16
- * <p>
17
- * <code>DetectLabels</code> does not support the detection of activities. However, activity detection
18
- * is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.</p>
19
- * </note>
20
- *
21
- * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
22
- * an Amazon S3 bucket. If you use the
23
- * AWS
24
- * CLI to call Amazon Rekognition operations, passing image bytes is not
25
- * supported. The image must be either a PNG or JPEG formatted file. </p>
26
- * <p> For each object, scene, and concept the API returns one or more labels. Each label
27
- * provides the object name, and the level of confidence that the image contains the object. For
28
- * example, suppose the input image has a lighthouse, the sea, and a rock. The response includes
29
- * all three labels, one for each object. </p>
30
- *
31
- * <p>
32
- * <code>{Name: lighthouse, Confidence: 98.4629}</code>
33
- * </p>
34
- * <p>
35
- * <code>{Name: rock,Confidence: 79.2097}</code>
36
- * </p>
37
- * <p>
38
- * <code> {Name: sea,Confidence: 75.061}</code>
39
- * </p>
40
- * <p>In the preceding example, the operation returns one label for each of the three
41
- * objects. The operation can also return multiple labels for the same object in the image. For
42
- * example, if the input image shows a flower (for example, a tulip), the operation might return
43
- * the following three labels. </p>
44
- * <p>
45
- * <code>{Name: flower,Confidence: 99.0562}</code>
46
- * </p>
47
- * <p>
48
- * <code>{Name: plant,Confidence: 99.0562}</code>
49
- * </p>
50
- * <p>
51
- * <code>{Name: tulip,Confidence: 99.0562}</code>
52
- * </p>
53
- *
54
- * <p>In this example, the detection algorithm more precisely identifies the flower as a
55
- * tulip.</p>
56
- * <p>In response, the API returns an array of labels. In addition, the response also
57
- * includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to
58
- * control the confidence threshold for the labels returned. The default is 55%. You can also add
59
- * the <code>MaxLabels</code> parameter to limit the number of labels returned. </p>
60
- * <note>
61
- * <p>If the object detected is a person, the operation doesn't provide the same facial
62
- * details that the <a>DetectFaces</a> operation provides.</p>
63
- * </note>
64
- * <p>
65
- * <code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of
66
- * <a>Instance</a> objects. An <code>Instance</code> object contains a
67
- * <a>BoundingBox</a> object, for the location of the label on the image. It also includes
68
- * the confidence by which the bounding box was detected.</p>
69
- * <p>
70
- * <code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example,
71
- * a detected car might be assigned the label <i>car</i>. The label <i>car</i>
72
- * has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its
73
- * grandparent).
74
- * The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.
75
- * In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i>
76
- * are returned as unique labels in the response.
77
- * </p>
78
- * <p>This is a stateless API operation. That is, the operation does not persist any
79
- * data.</p>
80
- * <p>This operation requires permissions to perform the
81
- * <code>rekognition:DetectLabels</code> action. </p>
82
- * @example
83
- * Use a bare-bones client and the command you need to make an API call.
84
- * ```javascript
85
- * import { RekognitionClient, DetectLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
86
- * // const { RekognitionClient, DetectLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
87
- * const client = new RekognitionClient(config);
88
- * const command = new DetectLabelsCommand(input);
89
- * const response = await client.send(command);
90
- * ```
91
- *
92
- * @see {@link DetectLabelsCommandInput} for command's `input` shape.
93
- * @see {@link DetectLabelsCommandOutput} for command's `response` shape.
94
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
95
- *
96
- */
97
8
  class DetectLabelsCommand extends smithy_client_1.Command {
98
- // Start section: command_properties
99
- // End section: command_properties
100
9
  constructor(input) {
101
- // Start section: command_constructor
102
10
  super();
103
11
  this.input = input;
104
- // End section: command_constructor
105
12
  }
106
- /**
107
- * @internal
108
- */
109
13
  resolveMiddleware(clientStack, configuration, options) {
110
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
111
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,48 +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>Detects unsafe content in a specified JPEG or PNG format image.
10
- * Use <code>DetectModerationLabels</code> to moderate images depending on your requirements.
11
- * For example, you might want to filter images that contain nudity, but not images containing
12
- * suggestive content.</p>
13
- * <p>To filter images, use the labels returned by <code>DetectModerationLabels</code>
14
- * to determine which types of content are appropriate.</p>
15
- *
16
- * <p>For information about moderation labels,
17
- * see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>
18
- * <p>You pass the input image either as base64-encoded image bytes or as a reference to an
19
- * image in an Amazon S3 bucket. If you use the
20
- * AWS
21
- * CLI to call Amazon Rekognition operations, passing image bytes is not
22
- * supported. The image must be either a PNG or JPEG formatted file. </p>
23
- * @example
24
- * Use a bare-bones client and the command you need to make an API call.
25
- * ```javascript
26
- * import { RekognitionClient, DetectModerationLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
27
- * // const { RekognitionClient, DetectModerationLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
28
- * const client = new RekognitionClient(config);
29
- * const command = new DetectModerationLabelsCommand(input);
30
- * const response = await client.send(command);
31
- * ```
32
- *
33
- * @see {@link DetectModerationLabelsCommandInput} for command's `input` shape.
34
- * @see {@link DetectModerationLabelsCommandOutput} for command's `response` shape.
35
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
36
- *
37
- */
38
8
  class DetectModerationLabelsCommand extends smithy_client_1.Command {
39
- // Start section: command_properties
40
- // End section: command_properties
41
9
  constructor(input) {
42
- // Start section: command_constructor
43
10
  super();
44
11
  this.input = input;
45
- // End section: command_constructor
46
12
  }
47
- /**
48
- * @internal
49
- */
50
13
  resolveMiddleware(clientStack, configuration, options) {
51
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
52
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,74 +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>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the
10
- * following types of PPE.</p>
11
- * <ul>
12
- * <li>
13
- * <p>Face cover</p>
14
- * </li>
15
- * <li>
16
- * <p>Hand cover</p>
17
- * </li>
18
- * <li>
19
- * <p>Head cover</p>
20
- * </li>
21
- * </ul>
22
- *
23
- * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
24
- * The image must be either a PNG or JPG formatted file. </p>
25
- *
26
- * <p>
27
- * <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>
28
- * <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).
29
- * For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE
30
- * covers the body part. The API returns the confidence it has in each detection
31
- * (person, PPE, body part and body part coverage). It also returns a bounding box (<a>BoundingBox</a>) for each detected
32
- * person and each detected item of PPE. </p>
33
- * <p>You can optionally request a summary of detected PPE items with the <code>SummarizationAttributes</code> input parameter.
34
- * The summary provides the following information. </p>
35
- * <ul>
36
- * <li>
37
- * <p>The persons detected as wearing all of the types of PPE that you specify.</p>
38
- * </li>
39
- * <li>
40
- * <p>The persons detected as not wearing all of the types PPE that you specify.</p>
41
- * </li>
42
- * <li>
43
- * <p>The persons detected where PPE adornment could not be determined. </p>
44
- * </li>
45
- * </ul>
46
- * <p>This is a stateless API operation. That is, the operation does not persist any data.</p>
47
- *
48
- * <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>
49
- * @example
50
- * Use a bare-bones client and the command you need to make an API call.
51
- * ```javascript
52
- * import { RekognitionClient, DetectProtectiveEquipmentCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
53
- * // const { RekognitionClient, DetectProtectiveEquipmentCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
54
- * const client = new RekognitionClient(config);
55
- * const command = new DetectProtectiveEquipmentCommand(input);
56
- * const response = await client.send(command);
57
- * ```
58
- *
59
- * @see {@link DetectProtectiveEquipmentCommandInput} for command's `input` shape.
60
- * @see {@link DetectProtectiveEquipmentCommandOutput} for command's `response` shape.
61
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
62
- *
63
- */
64
8
  class DetectProtectiveEquipmentCommand extends smithy_client_1.Command {
65
- // Start section: command_properties
66
- // End section: command_properties
67
9
  constructor(input) {
68
- // Start section: command_constructor
69
10
  super();
70
11
  this.input = input;
71
- // End section: command_constructor
72
12
  }
73
- /**
74
- * @internal
75
- */
76
13
  resolveMiddleware(clientStack, configuration, options) {
77
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
78
15
  const stack = clientStack.concat(this.middlewareStack);
@@ -5,56 +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>Detects text in the input image and converts it into machine-readable text.</p>
10
- * <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an
11
- * Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
12
- * reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not
13
- * supported. The image must be either a .png or .jpeg formatted file. </p>
14
- * <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each
15
- * <code>TextDetection</code> element provides information about a single word or line of text
16
- * that was detected in the image. </p>
17
- * <p>A word is one or more ISO basic latin script characters that are not separated by spaces.
18
- * <code>DetectText</code> can detect up to 100 words in an image.</p>
19
- * <p>A line is a string of equally spaced words. A line isn't necessarily a complete
20
- * sentence. For example, a driver's license number is detected as a line. A line ends when there
21
- * is no aligned text after it. Also, a line ends when there is a large gap between words,
22
- * relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition
23
- * may detect multiple lines in text aligned in the same direction. Periods don't represent the
24
- * end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation
25
- * returns multiple lines.</p>
26
- * <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,
27
- * use the <code>TextDetection</code> object <code>Type</code> field. </p>
28
- * <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>
29
- *
30
- * <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>
31
- * @example
32
- * Use a bare-bones client and the command you need to make an API call.
33
- * ```javascript
34
- * import { RekognitionClient, DetectTextCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
35
- * // const { RekognitionClient, DetectTextCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
36
- * const client = new RekognitionClient(config);
37
- * const command = new DetectTextCommand(input);
38
- * const response = await client.send(command);
39
- * ```
40
- *
41
- * @see {@link DetectTextCommandInput} for command's `input` shape.
42
- * @see {@link DetectTextCommandOutput} for command's `response` shape.
43
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
44
- *
45
- */
46
8
  class DetectTextCommand extends smithy_client_1.Command {
47
- // Start section: command_properties
48
- // End section: command_properties
49
9
  constructor(input) {
50
- // Start section: command_constructor
51
10
  super();
52
11
  this.input = input;
53
- // End section: command_constructor
54
12
  }
55
- /**
56
- * @internal
57
- */
58
13
  resolveMiddleware(clientStack, configuration, options) {
59
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
60
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>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
10
- * The additional information is returned as an array of URLs. If there is no additional
11
- * information about the celebrity, this list is empty.</p>
12
- *
13
- * <p>For more information, see Recognizing Celebrities in an Image in
14
- * the Amazon Rekognition Developer Guide.</p>
15
- * <p>This operation requires permissions to perform the
16
- * <code>rekognition:GetCelebrityInfo</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, GetCelebrityInfoCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
21
- * // const { RekognitionClient, GetCelebrityInfoCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
22
- * const client = new RekognitionClient(config);
23
- * const command = new GetCelebrityInfoCommand(input);
24
- * const response = await client.send(command);
25
- * ```
26
- *
27
- * @see {@link GetCelebrityInfoCommandInput} for command's `input` shape.
28
- * @see {@link GetCelebrityInfoCommandOutput} for command's `response` shape.
29
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
30
- *
31
- */
32
8
  class GetCelebrityInfoCommand 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,69 +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 the celebrity recognition results for a Amazon Rekognition Video analysis started by
10
- * <a>StartCelebrityRecognition</a>.</p>
11
- * <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call
12
- * to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>).
13
- * When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
14
- * topic registered in the initial call to <code>StartCelebrityRecognition</code>.
15
- * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
16
- * topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job identifier
17
- * (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
18
- *
19
- * <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
20
- * <p>
21
- * <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they are detected in an array
22
- * (<code>Celebrities</code>) of <a>CelebrityRecognition</a>
23
- * objects. Each <code>CelebrityRecognition</code> contains information about the celebrity in a <a>CelebrityDetail</a>
24
- * object and the time, <code>Timestamp</code>, the celebrity was detected.
25
- * </p>
26
- * <note>
27
- * <p>
28
- * <code>GetCelebrityRecognition</code> only returns the default
29
- * facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
30
- * <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
31
- * in the <code>Face</code> object of the following response syntax are not returned. For more information,
32
- * see FaceDetail in the Amazon Rekognition Developer Guide. </p>
33
- * </note>
34
- * <p>By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video).
35
- * You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter.</p>
36
- * <p>The <code>CelebrityDetail</code> object includes the celebrity identifer and additional information urls. If you don't store
37
- * the additional information urls, you can get them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer.</p>
38
- * <p>No information is returned for faces not recognized as celebrities.</p>
39
- * <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
40
- * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a
41
- * pagination token for getting the next set of results. To get the next page of results, call <code>GetCelebrityDetection</code>
42
- * and populate the <code>NextToken</code> request parameter with the token
43
- * value returned from the previous call to <code>GetCelebrityRecognition</code>.</p>
44
- * @example
45
- * Use a bare-bones client and the command you need to make an API call.
46
- * ```javascript
47
- * import { RekognitionClient, GetCelebrityRecognitionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
48
- * // const { RekognitionClient, GetCelebrityRecognitionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
49
- * const client = new RekognitionClient(config);
50
- * const command = new GetCelebrityRecognitionCommand(input);
51
- * const response = await client.send(command);
52
- * ```
53
- *
54
- * @see {@link GetCelebrityRecognitionCommandInput} for command's `input` shape.
55
- * @see {@link GetCelebrityRecognitionCommandOutput} for command's `response` shape.
56
- * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
57
- *
58
- */
59
8
  class GetCelebrityRecognitionCommand extends smithy_client_1.Command {
60
- // Start section: command_properties
61
- // End section: command_properties
62
9
  constructor(input) {
63
- // Start section: command_constructor
64
10
  super();
65
11
  this.input = input;
66
- // End section: command_constructor
67
12
  }
68
- /**
69
- * @internal
70
- */
71
13
  resolveMiddleware(clientStack, configuration, options) {
72
14
  this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
73
15
  const stack = clientStack.concat(this.middlewareStack);