@aws-sdk/client-rekognition 3.296.0 → 3.297.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 (85) hide show
  1. package/dist-types/Rekognition.d.ts +70 -6
  2. package/dist-types/RekognitionClient.d.ts +24 -4
  3. package/dist-types/commands/CompareFacesCommand.d.ts +16 -0
  4. package/dist-types/commands/CopyProjectVersionCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateProjectVersionCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteFacesCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeCollectionCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeProjectsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +16 -0
  22. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +16 -0
  23. package/dist-types/commands/DetectFacesCommand.d.ts +16 -0
  24. package/dist-types/commands/DetectLabelsCommand.d.ts +22 -6
  25. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +16 -0
  26. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +16 -0
  27. package/dist-types/commands/DetectTextCommand.d.ts +16 -0
  28. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +16 -0
  29. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +16 -0
  30. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +16 -0
  31. package/dist-types/commands/GetContentModerationCommand.d.ts +16 -0
  32. package/dist-types/commands/GetFaceDetectionCommand.d.ts +16 -0
  33. package/dist-types/commands/GetFaceSearchCommand.d.ts +16 -0
  34. package/dist-types/commands/GetLabelDetectionCommand.d.ts +16 -0
  35. package/dist-types/commands/GetPersonTrackingCommand.d.ts +16 -0
  36. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +16 -0
  37. package/dist-types/commands/GetTextDetectionCommand.d.ts +16 -0
  38. package/dist-types/commands/IndexFacesCommand.d.ts +16 -0
  39. package/dist-types/commands/ListCollectionsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +16 -0
  42. package/dist-types/commands/ListFacesCommand.d.ts +16 -0
  43. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
  44. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/PutProjectPolicyCommand.d.ts +16 -0
  47. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +16 -0
  48. package/dist-types/commands/SearchFacesByImageCommand.d.ts +16 -0
  49. package/dist-types/commands/SearchFacesCommand.d.ts +16 -0
  50. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartContentModerationCommand.d.ts +16 -0
  52. package/dist-types/commands/StartFaceDetectionCommand.d.ts +16 -0
  53. package/dist-types/commands/StartFaceSearchCommand.d.ts +16 -0
  54. package/dist-types/commands/StartLabelDetectionCommand.d.ts +16 -0
  55. package/dist-types/commands/StartPersonTrackingCommand.d.ts +16 -0
  56. package/dist-types/commands/StartProjectVersionCommand.d.ts +16 -0
  57. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +16 -0
  58. package/dist-types/commands/StartStreamProcessorCommand.d.ts +16 -0
  59. package/dist-types/commands/StartTextDetectionCommand.d.ts +16 -0
  60. package/dist-types/commands/StopProjectVersionCommand.d.ts +16 -0
  61. package/dist-types/commands/StopStreamProcessorCommand.d.ts +16 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +16 -0
  66. package/dist-types/models/RekognitionServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +610 -0
  68. package/dist-types/pagination/DescribeProjectVersionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/DescribeProjectsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/GetCelebrityRecognitionPaginator.d.ts +3 -0
  71. package/dist-types/pagination/GetContentModerationPaginator.d.ts +3 -0
  72. package/dist-types/pagination/GetFaceDetectionPaginator.d.ts +3 -0
  73. package/dist-types/pagination/GetFaceSearchPaginator.d.ts +3 -0
  74. package/dist-types/pagination/GetLabelDetectionPaginator.d.ts +3 -0
  75. package/dist-types/pagination/GetPersonTrackingPaginator.d.ts +3 -0
  76. package/dist-types/pagination/GetSegmentDetectionPaginator.d.ts +3 -0
  77. package/dist-types/pagination/GetTextDetectionPaginator.d.ts +3 -0
  78. package/dist-types/pagination/Interfaces.d.ts +3 -0
  79. package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListFacesPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListProjectPoliciesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListStreamProcessorsPaginator.d.ts +3 -0
  85. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DetectTextRequest, DetectTextResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectTextCommand}.
8
10
  */
9
11
  export interface DetectTextCommandInput extends DetectTextRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectTextCommand}.
13
17
  */
14
18
  export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects text in the input image and converts it into machine-readable text.</p>
18
23
  * <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an
19
24
  * Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
@@ -47,6 +52,8 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
47
52
  * const response = await client.send(command);
48
53
  * ```
49
54
  *
55
+ * @param DetectTextCommandInput - {@link DetectTextCommandInput}
56
+ * @returns {@link DetectTextCommandOutput}
50
57
  * @see {@link DetectTextCommandInput} for command's `input` shape.
51
58
  * @see {@link DetectTextCommandOutput} for command's `response` shape.
52
59
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -85,11 +92,20 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB
85
92
  export declare class DetectTextCommand extends $Command<DetectTextCommandInput, DetectTextCommandOutput, RekognitionClientResolvedConfig> {
86
93
  readonly input: DetectTextCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: DetectTextCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectTextCommandInput, DetectTextCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DistributeDatasetEntriesRequest, DistributeDatasetEntriesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DistributeDatasetEntriesCommand}.
8
10
  */
9
11
  export interface DistributeDatasetEntriesCommandInput extends DistributeDatasetEntriesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DistributeDatasetEntriesCommand}.
13
17
  */
14
18
  export interface DistributeDatasetEntriesCommandOutput extends DistributeDatasetEntriesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
18
23
  * <code>DistributeDatasetEntries</code> moves 20% of the training dataset images to the test dataset.
19
24
  * An entry is a JSON Line that describes an image.
@@ -35,6 +40,8 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param DistributeDatasetEntriesCommandInput - {@link DistributeDatasetEntriesCommandInput}
44
+ * @returns {@link DistributeDatasetEntriesCommandOutput}
38
45
  * @see {@link DistributeDatasetEntriesCommandInput} for command's `input` shape.
39
46
  * @see {@link DistributeDatasetEntriesCommandOutput} for command's `response` shape.
40
47
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -69,11 +76,20 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
69
76
  export declare class DistributeDatasetEntriesCommand extends $Command<DistributeDatasetEntriesCommandInput, DistributeDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
70
77
  readonly input: DistributeDatasetEntriesCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: DistributeDatasetEntriesCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DistributeDatasetEntriesCommandInput, DistributeDatasetEntriesCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCelebrityInfoRequest, GetCelebrityInfoResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCelebrityInfoCommand}.
8
10
  */
9
11
  export interface GetCelebrityInfoCommandInput extends GetCelebrityInfoRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCelebrityInfoCommand}.
13
17
  */
14
18
  export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
18
23
  * The additional information is returned as an array of URLs. If there is no additional
19
24
  * information about the celebrity, this list is empty.</p>
@@ -31,6 +36,8 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetCelebrityInfoCommandInput - {@link GetCelebrityInfoCommandInput}
40
+ * @returns {@link GetCelebrityInfoCommandOutput}
34
41
  * @see {@link GetCelebrityInfoCommandInput} for command's `input` shape.
35
42
  * @see {@link GetCelebrityInfoCommandOutput} for command's `response` shape.
36
43
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -60,11 +67,20 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse,
60
67
  export declare class GetCelebrityInfoCommand extends $Command<GetCelebrityInfoCommandInput, GetCelebrityInfoCommandOutput, RekognitionClientResolvedConfig> {
61
68
  readonly input: GetCelebrityInfoCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: GetCelebrityInfoCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCelebrityInfoCommandInput, GetCelebrityInfoCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetCelebrityRecognitionRequest, GetCelebrityRecognitionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCelebrityRecognitionCommand}.
8
10
  */
9
11
  export interface GetCelebrityRecognitionCommandInput extends GetCelebrityRecognitionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCelebrityRecognitionCommand}.
13
17
  */
14
18
  export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecognitionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
18
23
  * <a>StartCelebrityRecognition</a>.</p>
19
24
  * <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a
@@ -63,6 +68,8 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
63
68
  * const response = await client.send(command);
64
69
  * ```
65
70
  *
71
+ * @param GetCelebrityRecognitionCommandInput - {@link GetCelebrityRecognitionCommandInput}
72
+ * @returns {@link GetCelebrityRecognitionCommandOutput}
66
73
  * @see {@link GetCelebrityRecognitionCommandInput} for command's `input` shape.
67
74
  * @see {@link GetCelebrityRecognitionCommandOutput} for command's `response` shape.
68
75
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -95,11 +102,20 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
95
102
  export declare class GetCelebrityRecognitionCommand extends $Command<GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput, RekognitionClientResolvedConfig> {
96
103
  readonly input: GetCelebrityRecognitionCommandInput;
97
104
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
105
+ /**
106
+ * @public
107
+ */
98
108
  constructor(input: GetCelebrityRecognitionCommandInput);
99
109
  /**
100
110
  * @internal
101
111
  */
102
112
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput>;
113
+ /**
114
+ * @internal
115
+ */
103
116
  private serialize;
117
+ /**
118
+ * @internal
119
+ */
104
120
  private deserialize;
105
121
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetContentModerationRequest, GetContentModerationResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetContentModerationCommand}.
8
10
  */
9
11
  export interface GetContentModerationCommandInput extends GetContentModerationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetContentModerationCommand}.
13
17
  */
14
18
  export interface GetContentModerationCommandOutput extends GetContentModerationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
18
23
  * <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
19
24
  * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
@@ -51,6 +56,8 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
51
56
  * const response = await client.send(command);
52
57
  * ```
53
58
  *
59
+ * @param GetContentModerationCommandInput - {@link GetContentModerationCommandInput}
60
+ * @returns {@link GetContentModerationCommandOutput}
54
61
  * @see {@link GetContentModerationCommandInput} for command's `input` shape.
55
62
  * @see {@link GetContentModerationCommandOutput} for command's `response` shape.
56
63
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -83,11 +90,20 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
83
90
  export declare class GetContentModerationCommand extends $Command<GetContentModerationCommandInput, GetContentModerationCommandOutput, RekognitionClientResolvedConfig> {
84
91
  readonly input: GetContentModerationCommandInput;
85
92
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
93
+ /**
94
+ * @public
95
+ */
86
96
  constructor(input: GetContentModerationCommandInput);
87
97
  /**
88
98
  * @internal
89
99
  */
90
100
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetContentModerationCommandInput, GetContentModerationCommandOutput>;
101
+ /**
102
+ * @internal
103
+ */
91
104
  private serialize;
105
+ /**
106
+ * @internal
107
+ */
92
108
  private deserialize;
93
109
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetFaceDetectionRequest, GetFaceDetectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetFaceDetectionCommand}.
8
10
  */
9
11
  export interface GetFaceDetectionCommandInput extends GetFaceDetectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetFaceDetectionCommand}.
13
17
  */
14
18
  export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>.</p>
18
23
  * <p>Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a>
19
24
  * which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to
@@ -37,6 +42,8 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param GetFaceDetectionCommandInput - {@link GetFaceDetectionCommandInput}
46
+ * @returns {@link GetFaceDetectionCommandOutput}
40
47
  * @see {@link GetFaceDetectionCommandInput} for command's `input` shape.
41
48
  * @see {@link GetFaceDetectionCommandOutput} for command's `response` shape.
42
49
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -69,11 +76,20 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
69
76
  export declare class GetFaceDetectionCommand extends $Command<GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput, RekognitionClientResolvedConfig> {
70
77
  readonly input: GetFaceDetectionCommandInput;
71
78
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
72
82
  constructor(input: GetFaceDetectionCommandInput);
73
83
  /**
74
84
  * @internal
75
85
  */
76
86
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
77
90
  private serialize;
91
+ /**
92
+ * @internal
93
+ */
78
94
  private deserialize;
79
95
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetFaceSearchRequest, GetFaceSearchResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetFaceSearchCommand}.
8
10
  */
9
11
  export interface GetFaceSearchCommandInput extends GetFaceSearchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetFaceSearchCommand}.
13
17
  */
14
18
  export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the face search results for Amazon Rekognition Video face search started by
18
23
  * <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces
19
24
  * of persons detected in a video. It also includes the time(s) that faces are matched in the video.</p>
@@ -53,6 +58,8 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
53
58
  * const response = await client.send(command);
54
59
  * ```
55
60
  *
61
+ * @param GetFaceSearchCommandInput - {@link GetFaceSearchCommandInput}
62
+ * @returns {@link GetFaceSearchCommandOutput}
56
63
  * @see {@link GetFaceSearchCommandInput} for command's `input` shape.
57
64
  * @see {@link GetFaceSearchCommandOutput} for command's `response` shape.
58
65
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -85,11 +92,20 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
85
92
  export declare class GetFaceSearchCommand extends $Command<GetFaceSearchCommandInput, GetFaceSearchCommandOutput, RekognitionClientResolvedConfig> {
86
93
  readonly input: GetFaceSearchCommandInput;
87
94
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
95
+ /**
96
+ * @public
97
+ */
88
98
  constructor(input: GetFaceSearchCommandInput);
89
99
  /**
90
100
  * @internal
91
101
  */
92
102
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFaceSearchCommandInput, GetFaceSearchCommandOutput>;
103
+ /**
104
+ * @internal
105
+ */
93
106
  private serialize;
107
+ /**
108
+ * @internal
109
+ */
94
110
  private deserialize;
95
111
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetLabelDetectionRequest, GetLabelDetectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLabelDetectionCommand}.
8
10
  */
9
11
  export interface GetLabelDetectionCommandInput extends GetLabelDetectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLabelDetectionCommand}.
13
17
  */
14
18
  export interface GetLabelDetectionCommandOutput extends GetLabelDetectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
18
23
  * <p>The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When
19
24
  * the label detection operation finishes, Amazon Rekognition publishes a completion status to the
@@ -90,6 +95,8 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
90
95
  * const response = await client.send(command);
91
96
  * ```
92
97
  *
98
+ * @param GetLabelDetectionCommandInput - {@link GetLabelDetectionCommandInput}
99
+ * @returns {@link GetLabelDetectionCommandOutput}
93
100
  * @see {@link GetLabelDetectionCommandInput} for command's `input` shape.
94
101
  * @see {@link GetLabelDetectionCommandOutput} for command's `response` shape.
95
102
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -122,11 +129,20 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
122
129
  export declare class GetLabelDetectionCommand extends $Command<GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput, RekognitionClientResolvedConfig> {
123
130
  readonly input: GetLabelDetectionCommandInput;
124
131
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
132
+ /**
133
+ * @public
134
+ */
125
135
  constructor(input: GetLabelDetectionCommandInput);
126
136
  /**
127
137
  * @internal
128
138
  */
129
139
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput>;
140
+ /**
141
+ * @internal
142
+ */
130
143
  private serialize;
144
+ /**
145
+ * @internal
146
+ */
131
147
  private deserialize;
132
148
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetPersonTrackingRequest, GetPersonTrackingResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetPersonTrackingCommand}.
8
10
  */
9
11
  export interface GetPersonTrackingCommandInput extends GetPersonTrackingRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetPersonTrackingCommand}.
13
17
  */
14
18
  export interface GetPersonTrackingCommandOutput extends GetPersonTrackingResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
18
23
  * <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
19
24
  * which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
@@ -49,6 +54,8 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param GetPersonTrackingCommandInput - {@link GetPersonTrackingCommandInput}
58
+ * @returns {@link GetPersonTrackingCommandOutput}
52
59
  * @see {@link GetPersonTrackingCommandInput} for command's `input` shape.
53
60
  * @see {@link GetPersonTrackingCommandOutput} for command's `response` shape.
54
61
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -81,11 +88,20 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
81
88
  export declare class GetPersonTrackingCommand extends $Command<GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput, RekognitionClientResolvedConfig> {
82
89
  readonly input: GetPersonTrackingCommandInput;
83
90
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
91
+ /**
92
+ * @public
93
+ */
84
94
  constructor(input: GetPersonTrackingCommandInput);
85
95
  /**
86
96
  * @internal
87
97
  */
88
98
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput>;
99
+ /**
100
+ * @internal
101
+ */
89
102
  private serialize;
103
+ /**
104
+ * @internal
105
+ */
90
106
  private deserialize;
91
107
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetSegmentDetectionRequest, GetSegmentDetectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSegmentDetectionCommand}.
8
10
  */
9
11
  export interface GetSegmentDetectionCommandInput extends GetSegmentDetectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSegmentDetectionCommand}.
13
17
  */
14
18
  export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the segment detection results of a Amazon Rekognition Video analysis started by <a>StartSegmentDetection</a>.</p>
18
23
  * <p>Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
19
24
  * calling <a>StartSegmentDetection</a> which returns a job identifier (<code>JobId</code>).
@@ -46,6 +51,8 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param GetSegmentDetectionCommandInput - {@link GetSegmentDetectionCommandInput}
55
+ * @returns {@link GetSegmentDetectionCommandOutput}
49
56
  * @see {@link GetSegmentDetectionCommandInput} for command's `input` shape.
50
57
  * @see {@link GetSegmentDetectionCommandOutput} for command's `response` shape.
51
58
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -78,11 +85,20 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes
78
85
  export declare class GetSegmentDetectionCommand extends $Command<GetSegmentDetectionCommandInput, GetSegmentDetectionCommandOutput, RekognitionClientResolvedConfig> {
79
86
  readonly input: GetSegmentDetectionCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: GetSegmentDetectionCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSegmentDetectionCommandInput, GetSegmentDetectionCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetTextDetectionRequest, GetTextDetectionResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetTextDetectionCommand}.
8
10
  */
9
11
  export interface GetTextDetectionCommandInput extends GetTextDetectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetTextDetectionCommand}.
13
17
  */
14
18
  export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p>
18
23
  * <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
19
24
  * calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>)
@@ -43,6 +48,8 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
43
48
  * const response = await client.send(command);
44
49
  * ```
45
50
  *
51
+ * @param GetTextDetectionCommandInput - {@link GetTextDetectionCommandInput}
52
+ * @returns {@link GetTextDetectionCommandOutput}
46
53
  * @see {@link GetTextDetectionCommandInput} for command's `input` shape.
47
54
  * @see {@link GetTextDetectionCommandOutput} for command's `response` shape.
48
55
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -75,11 +82,20 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
75
82
  export declare class GetTextDetectionCommand extends $Command<GetTextDetectionCommandInput, GetTextDetectionCommandOutput, RekognitionClientResolvedConfig> {
76
83
  readonly input: GetTextDetectionCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: GetTextDetectionCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetTextDetectionCommandInput, GetTextDetectionCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { IndexFacesRequest, IndexFacesResponse } from "../models/models_0";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link IndexFacesCommand}.
8
10
  */
9
11
  export interface IndexFacesCommandInput extends IndexFacesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link IndexFacesCommand}.
13
17
  */
14
18
  export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Detects faces in the input image and adds them to the specified collection. </p>
18
23
  * <p>Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying
19
24
  * detection algorithm first detects the faces in the input image. For each face, the algorithm
@@ -115,6 +120,8 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
115
120
  * const response = await client.send(command);
116
121
  * ```
117
122
  *
123
+ * @param IndexFacesCommandInput - {@link IndexFacesCommandInput}
124
+ * @returns {@link IndexFacesCommandOutput}
118
125
  * @see {@link IndexFacesCommandInput} for command's `input` shape.
119
126
  * @see {@link IndexFacesCommandOutput} for command's `response` shape.
120
127
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
@@ -303,11 +310,20 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
303
310
  export declare class IndexFacesCommand extends $Command<IndexFacesCommandInput, IndexFacesCommandOutput, RekognitionClientResolvedConfig> {
304
311
  readonly input: IndexFacesCommandInput;
305
312
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
313
+ /**
314
+ * @public
315
+ */
306
316
  constructor(input: IndexFacesCommandInput);
307
317
  /**
308
318
  * @internal
309
319
  */
310
320
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<IndexFacesCommandInput, IndexFacesCommandOutput>;
321
+ /**
322
+ * @internal
323
+ */
311
324
  private serialize;
325
+ /**
326
+ * @internal
327
+ */
312
328
  private deserialize;
313
329
  }