@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.
- package/CHANGELOG.md +42 -0
- package/dist-cjs/Rekognition.js +0 -3
- package/dist-cjs/RekognitionClient.js +0 -8
- package/dist-cjs/commands/CompareFacesCommand.js +0 -86
- package/dist-cjs/commands/CreateCollectionCommand.js +0 -36
- package/dist-cjs/commands/CreateProjectCommand.js +0 -26
- package/dist-cjs/commands/CreateProjectVersionCommand.js +0 -35
- package/dist-cjs/commands/CreateStreamProcessorCommand.js +0 -34
- package/dist-cjs/commands/DeleteCollectionCommand.js +0 -28
- package/dist-cjs/commands/DeleteFacesCommand.js +0 -27
- package/dist-cjs/commands/DeleteProjectCommand.js +0 -27
- package/dist-cjs/commands/DeleteProjectVersionCommand.js +0 -31
- package/dist-cjs/commands/DeleteStreamProcessorCommand.js +0 -25
- package/dist-cjs/commands/DescribeCollectionCommand.js +0 -29
- package/dist-cjs/commands/DescribeProjectVersionsCommand.js +0 -28
- package/dist-cjs/commands/DescribeProjectsCommand.js +0 -25
- package/dist-cjs/commands/DescribeStreamProcessorCommand.js +0 -25
- package/dist-cjs/commands/DetectCustomLabelsCommand.js +0 -74
- package/dist-cjs/commands/DetectFacesCommand.js +0 -46
- package/dist-cjs/commands/DetectLabelsCommand.js +0 -96
- package/dist-cjs/commands/DetectModerationLabelsCommand.js +0 -37
- package/dist-cjs/commands/DetectProtectiveEquipmentCommand.js +0 -63
- package/dist-cjs/commands/DetectTextCommand.js +0 -45
- package/dist-cjs/commands/GetCelebrityInfoCommand.js +0 -31
- package/dist-cjs/commands/GetCelebrityRecognitionCommand.js +0 -58
- package/dist-cjs/commands/GetContentModerationCommand.js +0 -53
- package/dist-cjs/commands/GetFaceDetectionCommand.js +0 -36
- package/dist-cjs/commands/GetFaceSearchCommand.js +0 -54
- package/dist-cjs/commands/GetLabelDetectionCommand.js +0 -44
- package/dist-cjs/commands/GetPersonTrackingCommand.js +0 -53
- package/dist-cjs/commands/GetSegmentDetectionCommand.js +0 -46
- package/dist-cjs/commands/GetTextDetectionCommand.js +0 -42
- package/dist-cjs/commands/IndexFacesCommand.js +0 -123
- package/dist-cjs/commands/ListCollectionsCommand.js +0 -29
- package/dist-cjs/commands/ListFacesCommand.js +0 -31
- package/dist-cjs/commands/ListStreamProcessorsCommand.js +0 -24
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -28
- package/dist-cjs/commands/RecognizeCelebritiesCommand.js +0 -54
- package/dist-cjs/commands/SearchFacesByImageCommand.js +0 -70
- package/dist-cjs/commands/SearchFacesCommand.js +0 -44
- package/dist-cjs/commands/StartCelebrityRecognitionCommand.js +0 -35
- package/dist-cjs/commands/StartContentModerationCommand.js +0 -35
- package/dist-cjs/commands/StartFaceDetectionCommand.js +0 -36
- package/dist-cjs/commands/StartFaceSearchCommand.js +0 -33
- package/dist-cjs/commands/StartLabelDetectionCommand.js +0 -38
- package/dist-cjs/commands/StartPersonTrackingCommand.js +0 -32
- package/dist-cjs/commands/StartProjectVersionCommand.js +0 -33
- package/dist-cjs/commands/StartSegmentDetectionCommand.js +0 -39
- package/dist-cjs/commands/StartStreamProcessorCommand.js +0 -26
- package/dist-cjs/commands/StartTextDetectionCommand.js +0 -31
- package/dist-cjs/commands/StopProjectVersionCommand.js +0 -25
- package/dist-cjs/commands/StopStreamProcessorCommand.js +0 -24
- package/dist-cjs/commands/TagResourceCommand.js +0 -28
- package/dist-cjs/commands/UntagResourceCommand.js +0 -28
- package/dist-cjs/commands/index.js +54 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +5 -69
- package/dist-cjs/models/models_0.js +0 -621
- package/dist-cjs/pagination/DescribeProjectVersionsPaginator.js +0 -10
- package/dist-cjs/pagination/DescribeProjectsPaginator.js +0 -10
- package/dist-cjs/pagination/GetCelebrityRecognitionPaginator.js +0 -10
- package/dist-cjs/pagination/GetContentModerationPaginator.js +0 -10
- package/dist-cjs/pagination/GetFaceDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetFaceSearchPaginator.js +0 -10
- package/dist-cjs/pagination/GetLabelDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetPersonTrackingPaginator.js +0 -10
- package/dist-cjs/pagination/GetSegmentDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetTextDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/ListCollectionsPaginator.js +0 -10
- package/dist-cjs/pagination/ListFacesPaginator.js +0 -10
- package/dist-cjs/pagination/ListStreamProcessorsPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +17 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-cjs/waiters/index.js +5 -0
- package/dist-cjs/waiters/waitForProjectVersionRunning.js +0 -9
- package/dist-cjs/waiters/waitForProjectVersionTrainingCompleted.js +0 -9
- package/dist-es/commands/index.js +51 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +5 -69
- package/dist-es/pagination/index.js +14 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-types/commands/index.d.ts +51 -0
- package/dist-types/index.d.ts +5 -69
- package/dist-types/pagination/index.d.ts +14 -0
- package/dist-types/ts3.4/Rekognition.d.ts +52 -1018
- package/dist-types/ts3.4/RekognitionClient.d.ts +24 -89
- package/dist-types/ts3.4/commands/CompareFacesCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/CreateCollectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/CreateProjectVersionCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/CreateStreamProcessorCommand.d.ts +2 -30
- package/dist-types/ts3.4/commands/DeleteCollectionCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DeleteFacesCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteProjectCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteProjectVersionCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/DeleteStreamProcessorCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DescribeCollectionCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/DescribeProjectVersionsCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DescribeProjectsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DescribeStreamProcessorCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DetectCustomLabelsCommand.d.ts +2 -70
- package/dist-types/ts3.4/commands/DetectFacesCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/DetectLabelsCommand.d.ts +2 -92
- package/dist-types/ts3.4/commands/DetectModerationLabelsCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/DetectProtectiveEquipmentCommand.d.ts +2 -59
- package/dist-types/ts3.4/commands/DetectTextCommand.d.ts +2 -41
- package/dist-types/ts3.4/commands/GetCelebrityInfoCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/GetCelebrityRecognitionCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/GetContentModerationCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/GetFaceDetectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/GetFaceSearchCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/GetLabelDetectionCommand.d.ts +2 -40
- package/dist-types/ts3.4/commands/GetPersonTrackingCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/GetSegmentDetectionCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/GetTextDetectionCommand.d.ts +2 -38
- package/dist-types/ts3.4/commands/IndexFacesCommand.d.ts +2 -119
- package/dist-types/ts3.4/commands/ListCollectionsCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/ListFacesCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/ListStreamProcessorsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/RecognizeCelebritiesCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/SearchFacesByImageCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/SearchFacesCommand.d.ts +2 -40
- package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/StartContentModerationCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/StartFaceDetectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/StartFaceSearchCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/StartLabelDetectionCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/StartPersonTrackingCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/StartProjectVersionCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/StartSegmentDetectionCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/StartStreamProcessorCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/StartTextDetectionCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/StopProjectVersionCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/StopStreamProcessorCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/index.d.ts +51 -0
- package/dist-types/ts3.4/index.d.ts +5 -69
- package/dist-types/ts3.4/models/models_0.d.ts +856 -3431
- package/dist-types/ts3.4/pagination/index.d.ts +14 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForProjectVersionRunning.d.ts +2 -9
- package/dist-types/ts3.4/waiters/waitForProjectVersionTrainingCompleted.d.ts +2 -9
- package/dist-types/waiters/index.d.ts +2 -0
- package/package.json +33 -33
|
@@ -51,1175 +51,209 @@ import { StopStreamProcessorCommandInput, StopStreamProcessorCommandOutput } fro
|
|
|
51
51
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
52
52
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
53
53
|
import { RekognitionClient } from "./RekognitionClient";
|
|
54
|
-
|
|
55
|
-
* <p>This is the Amazon Rekognition API reference.</p>
|
|
56
|
-
*/
|
|
54
|
+
|
|
57
55
|
export declare class Rekognition extends RekognitionClient {
|
|
58
|
-
|
|
59
|
-
* <p>Compares a face in the <i>source</i> input image with
|
|
60
|
-
* each of the 100 largest faces detected in the <i>target</i> input image.
|
|
61
|
-
* </p>
|
|
62
|
-
*
|
|
63
|
-
* <p> If the source image contains multiple faces, the service detects the largest face
|
|
64
|
-
* and compares it with each face detected in the target image. </p>
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
* <note>
|
|
68
|
-
* <p>CompareFaces uses machine learning algorithms, which are probabilistic.
|
|
69
|
-
* A false negative is an incorrect prediction that
|
|
70
|
-
* a face in the target image has a low similarity confidence score when compared to the face
|
|
71
|
-
* in the source image. To reduce the probability of false negatives,
|
|
72
|
-
* we recommend that you compare the target image against multiple source images.
|
|
73
|
-
* If you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's rights,
|
|
74
|
-
* privacy, or access to services, we recommend that you pass the result to a human for review and further
|
|
75
|
-
* validation before taking action.</p>
|
|
76
|
-
* </note>
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
* <p>You pass the input and target images either as base64-encoded image bytes or as
|
|
80
|
-
* references to images in an Amazon S3 bucket. If you use the
|
|
81
|
-
* AWS
|
|
82
|
-
* CLI to call Amazon Rekognition operations, passing image bytes isn't
|
|
83
|
-
* supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
84
|
-
* <p>In response, the operation returns an array of face matches ordered by similarity score
|
|
85
|
-
* in descending order. For each face match, the response provides a bounding box of the face,
|
|
86
|
-
* facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and
|
|
87
|
-
* confidence value (indicating the level of confidence that the bounding box contains a face).
|
|
88
|
-
* The response also provides a similarity score, which indicates how closely the faces match. </p>
|
|
89
|
-
*
|
|
90
|
-
* <note>
|
|
91
|
-
* <p>By default, only faces with a similarity score of greater than or equal to 80% are
|
|
92
|
-
* returned in the response. You can change this value by specifying the
|
|
93
|
-
* <code>SimilarityThreshold</code> parameter.</p>
|
|
94
|
-
* </note>
|
|
95
|
-
*
|
|
96
|
-
* <p>
|
|
97
|
-
* <code>CompareFaces</code> also returns an array of faces that don't match the source image.
|
|
98
|
-
* For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.
|
|
99
|
-
* The response also returns information about the face in the source image, including the bounding box
|
|
100
|
-
* of the face and confidence value.</p>
|
|
101
|
-
*
|
|
102
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
103
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
104
|
-
* variety of common use cases. Use <code>QualityFilter</code> to set the quality bar
|
|
105
|
-
* by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
|
|
106
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
|
|
107
|
-
*
|
|
108
|
-
* <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the
|
|
109
|
-
* source and target images. Use these values to display the images with the correct image orientation.</p>
|
|
110
|
-
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code> returns an
|
|
111
|
-
* <code>InvalidParameterException</code> error. </p>
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* <note>
|
|
115
|
-
* <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p>
|
|
116
|
-
* </note>
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.</p>
|
|
120
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code>
|
|
121
|
-
* action.</p>
|
|
122
|
-
*/
|
|
56
|
+
|
|
123
57
|
compareFaces(args: CompareFacesCommandInput, options?: __HttpHandlerOptions): Promise<CompareFacesCommandOutput>;
|
|
124
58
|
compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
125
59
|
compareFaces(args: CompareFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
126
|
-
|
|
127
|
-
* <p>Creates a collection in an AWS Region. You can add faces to the collection using the
|
|
128
|
-
* <a>IndexFaces</a> operation. </p>
|
|
129
|
-
* <p>For example, you might create collections, one for each of your application users. A
|
|
130
|
-
* user can then index faces using the <code>IndexFaces</code> operation and persist results in a
|
|
131
|
-
* specific collection. Then, a user can search the collection for faces in the user-specific
|
|
132
|
-
* container. </p>
|
|
133
|
-
* <p>When you create a collection, it is associated with the latest version of the face model version.</p>
|
|
134
|
-
* <note>
|
|
135
|
-
* <p>Collection names are case-sensitive.</p>
|
|
136
|
-
* </note>
|
|
137
|
-
*
|
|
138
|
-
* <p>This operation requires permissions to perform the
|
|
139
|
-
* <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>
|
|
140
|
-
*/
|
|
60
|
+
|
|
141
61
|
createCollection(args: CreateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateCollectionCommandOutput>;
|
|
142
62
|
createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
143
63
|
createCollection(args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
144
|
-
|
|
145
|
-
* <p>Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models)
|
|
146
|
-
* and operations (training, evaluation and detection). </p>
|
|
147
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
|
|
148
|
-
*/
|
|
64
|
+
|
|
149
65
|
createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectCommandOutput>;
|
|
150
66
|
createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
151
67
|
createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
152
|
-
|
|
153
|
-
* <p>Creates a new version of a model and begins training.
|
|
154
|
-
* Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify
|
|
155
|
-
* one training dataset and one testing dataset. The response from <code>CreateProjectVersion</code>
|
|
156
|
-
* is an Amazon Resource Name (ARN) for the version of the model. </p>
|
|
157
|
-
* <p>Training takes a while to complete. You can get the current status by calling
|
|
158
|
-
* <a>DescribeProjectVersions</a>.</p>
|
|
159
|
-
* <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
|
|
160
|
-
* get the training results and evaluate the model.
|
|
161
|
-
* </p>
|
|
162
|
-
* <p>After evaluating the model, you start the model
|
|
163
|
-
* by calling <a>StartProjectVersion</a>.</p>
|
|
164
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
|
|
165
|
-
*/
|
|
68
|
+
|
|
166
69
|
createProjectVersion(args: CreateProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectVersionCommandOutput>;
|
|
167
70
|
createProjectVersion(args: CreateProjectVersionCommandInput, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
168
71
|
createProjectVersion(args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
169
|
-
|
|
170
|
-
* <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>
|
|
171
|
-
* <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>
|
|
172
|
-
* <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
|
|
173
|
-
* face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize.
|
|
174
|
-
* Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
|
|
175
|
-
* to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
|
|
176
|
-
* the <code>Name</code> field. </p>
|
|
177
|
-
* <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
|
|
178
|
-
* stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>
|
|
179
|
-
* <p>This operation requires permissions to perform the
|
|
180
|
-
* <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>
|
|
181
|
-
*/
|
|
72
|
+
|
|
182
73
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<CreateStreamProcessorCommandOutput>;
|
|
183
74
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
184
75
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
185
|
-
|
|
186
|
-
* <p>Deletes the specified collection. Note that this operation
|
|
187
|
-
* removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>.</p>
|
|
188
|
-
*
|
|
189
|
-
* <p>This operation requires permissions to perform the
|
|
190
|
-
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
191
|
-
*/
|
|
76
|
+
|
|
192
77
|
deleteCollection(args: DeleteCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCollectionCommandOutput>;
|
|
193
78
|
deleteCollection(args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
194
79
|
deleteCollection(args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
195
|
-
|
|
196
|
-
* <p>Deletes faces from a collection. You specify a collection ID and an array of face IDs
|
|
197
|
-
* to remove from the collection.</p>
|
|
198
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
|
|
199
|
-
* action.</p>
|
|
200
|
-
*/
|
|
80
|
+
|
|
201
81
|
deleteFaces(args: DeleteFacesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFacesCommandOutput>;
|
|
202
82
|
deleteFaces(args: DeleteFacesCommandInput, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
203
83
|
deleteFaces(args: DeleteFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
204
|
-
|
|
205
|
-
* <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
|
|
206
|
-
* with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
|
|
207
|
-
* <p>This operation requires permissions to perform the
|
|
208
|
-
* <code>rekognition:DeleteProject</code> action. </p>
|
|
209
|
-
*/
|
|
84
|
+
|
|
210
85
|
deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectCommandOutput>;
|
|
211
86
|
deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
212
87
|
deleteProject(args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
213
|
-
|
|
214
|
-
* <p>Deletes an Amazon Rekognition Custom Labels model. </p>
|
|
215
|
-
* <p>You can't delete a model if it is running or if it is training.
|
|
216
|
-
* To check the status of a model, use the <code>Status</code> field returned
|
|
217
|
-
* from <a>DescribeProjectVersions</a>.
|
|
218
|
-
* To stop a running model call <a>StopProjectVersion</a>. If the model
|
|
219
|
-
* is training, wait until it finishes.</p>
|
|
220
|
-
* <p>This operation requires permissions to perform the
|
|
221
|
-
* <code>rekognition:DeleteProjectVersion</code> action. </p>
|
|
222
|
-
*/
|
|
88
|
+
|
|
223
89
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectVersionCommandOutput>;
|
|
224
90
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
225
91
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
226
|
-
|
|
227
|
-
* <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
|
|
228
|
-
* <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>
|
|
229
|
-
*/
|
|
92
|
+
|
|
230
93
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStreamProcessorCommandOutput>;
|
|
231
94
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
232
95
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
233
|
-
|
|
234
|
-
* <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
|
|
235
|
-
* information, such as the number of faces indexed into a collection and the version of the
|
|
236
|
-
* model used by the collection for face detection.</p>
|
|
237
|
-
*
|
|
238
|
-
* <p>For more information, see Describing a Collection in the
|
|
239
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
240
|
-
*/
|
|
96
|
+
|
|
241
97
|
describeCollection(args: DescribeCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCollectionCommandOutput>;
|
|
242
98
|
describeCollection(args: DescribeCollectionCommandInput, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
243
99
|
describeCollection(args: DescribeCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
244
|
-
|
|
245
|
-
* <p>Lists and gets information about your Amazon Rekognition Custom Labels projects.</p>
|
|
246
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
|
|
247
|
-
*/
|
|
100
|
+
|
|
248
101
|
describeProjects(args: DescribeProjectsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProjectsCommandOutput>;
|
|
249
102
|
describeProjects(args: DescribeProjectsCommandInput, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
250
103
|
describeProjects(args: DescribeProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
251
|
-
|
|
252
|
-
* <p>Lists and describes the models in an Amazon Rekognition Custom Labels project. You
|
|
253
|
-
* can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
|
|
254
|
-
* you don't specify a value, descriptions for all models are returned.</p>
|
|
255
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>
|
|
256
|
-
* action.</p>
|
|
257
|
-
*/
|
|
104
|
+
|
|
258
105
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProjectVersionsCommandOutput>;
|
|
259
106
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
260
107
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
261
|
-
|
|
262
|
-
* <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,
|
|
263
|
-
* and the current status of the stream processor.</p>
|
|
264
|
-
*/
|
|
108
|
+
|
|
265
109
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStreamProcessorCommandOutput>;
|
|
266
110
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
267
111
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
268
|
-
|
|
269
|
-
* <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
|
|
270
|
-
* <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
|
|
271
|
-
* parameter. </p>
|
|
272
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
273
|
-
* an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
|
|
274
|
-
* image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
275
|
-
* <p> For each object that the model version detects on an image, the API returns a
|
|
276
|
-
* (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).
|
|
277
|
-
* Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
|
|
278
|
-
* of confidence that the image contains the object (<code>Confidence</code>), and
|
|
279
|
-
* object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
* <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
|
|
291
|
-
* <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
|
|
292
|
-
* the specified value.
|
|
293
|
-
*
|
|
294
|
-
* The value of <code>MinConfidence</code> maps to the assumed threshold values
|
|
295
|
-
* created during training. For more information, see <i>Assumed threshold</i>
|
|
296
|
-
* in the Amazon Rekognition Custom Labels Developer Guide.
|
|
297
|
-
* Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of
|
|
298
|
-
* <code>MinConfidence</code> normalizes the threshold value to a percentage value (0-100). Confidence
|
|
299
|
-
* responses from <code>DetectCustomLabels</code> are also returned as a percentage.
|
|
300
|
-
* You can use <code>MinConfidence</code> to change the precision and recall or your model.
|
|
301
|
-
* For more information, see
|
|
302
|
-
* <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
|
|
303
|
-
*
|
|
304
|
-
* <p>If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code>
|
|
305
|
-
* returns labels based on the assumed threshold of each label.</p>
|
|
306
|
-
*
|
|
307
|
-
*
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
312
|
-
* data.</p>
|
|
313
|
-
* <p>This operation requires permissions to perform the
|
|
314
|
-
* <code>rekognition:DetectCustomLabels</code> action. </p>
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
* <p>For more information, see
|
|
319
|
-
* <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
|
|
320
|
-
*/
|
|
112
|
+
|
|
321
113
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectCustomLabelsCommandOutput>;
|
|
322
114
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
323
115
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
324
|
-
|
|
325
|
-
* <p>Detects faces within an image that is provided as input.</p>
|
|
326
|
-
*
|
|
327
|
-
* <p>
|
|
328
|
-
* <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
|
|
329
|
-
* detected, the operation returns face details. These details include a bounding box of the
|
|
330
|
-
* face, a confidence value (that the bounding box contains a face), and a fixed set of
|
|
331
|
-
* attributes such as facial landmarks (for example, coordinates of eye and mouth),
|
|
332
|
-
* presence of beard, sunglasses, and so on. </p>
|
|
333
|
-
* <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
|
|
334
|
-
* obscured faces, the algorithm might not detect the faces or might detect faces with lower
|
|
335
|
-
* confidence. </p>
|
|
336
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
337
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI
|
|
338
|
-
* to call Amazon Rekognition operations, passing image bytes is not
|
|
339
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
340
|
-
*
|
|
341
|
-
* <note>
|
|
342
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
343
|
-
* data.</p>
|
|
344
|
-
* </note>
|
|
345
|
-
*
|
|
346
|
-
* <p>This operation requires permissions to perform the
|
|
347
|
-
* <code>rekognition:DetectFaces</code> action. </p>
|
|
348
|
-
*/
|
|
116
|
+
|
|
349
117
|
detectFaces(args: DetectFacesCommandInput, options?: __HttpHandlerOptions): Promise<DetectFacesCommandOutput>;
|
|
350
118
|
detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
351
119
|
detectFaces(args: DetectFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
352
|
-
|
|
353
|
-
* <p>Detects instances of real-world entities within an image (JPEG or PNG)
|
|
354
|
-
* provided as input. This includes objects like flower, tree, and table; events like
|
|
355
|
-
* wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
|
|
356
|
-
* </p>
|
|
357
|
-
*
|
|
358
|
-
* <p>For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.</p>
|
|
359
|
-
* <note>
|
|
360
|
-
* <p>
|
|
361
|
-
* <code>DetectLabels</code> does not support the detection of activities. However, activity detection
|
|
362
|
-
* is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.</p>
|
|
363
|
-
* </note>
|
|
364
|
-
*
|
|
365
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
366
|
-
* an Amazon S3 bucket. If you use the
|
|
367
|
-
* AWS
|
|
368
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
369
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
370
|
-
* <p> For each object, scene, and concept the API returns one or more labels. Each label
|
|
371
|
-
* provides the object name, and the level of confidence that the image contains the object. For
|
|
372
|
-
* example, suppose the input image has a lighthouse, the sea, and a rock. The response includes
|
|
373
|
-
* all three labels, one for each object. </p>
|
|
374
|
-
*
|
|
375
|
-
* <p>
|
|
376
|
-
* <code>{Name: lighthouse, Confidence: 98.4629}</code>
|
|
377
|
-
* </p>
|
|
378
|
-
* <p>
|
|
379
|
-
* <code>{Name: rock,Confidence: 79.2097}</code>
|
|
380
|
-
* </p>
|
|
381
|
-
* <p>
|
|
382
|
-
* <code> {Name: sea,Confidence: 75.061}</code>
|
|
383
|
-
* </p>
|
|
384
|
-
* <p>In the preceding example, the operation returns one label for each of the three
|
|
385
|
-
* objects. The operation can also return multiple labels for the same object in the image. For
|
|
386
|
-
* example, if the input image shows a flower (for example, a tulip), the operation might return
|
|
387
|
-
* the following three labels. </p>
|
|
388
|
-
* <p>
|
|
389
|
-
* <code>{Name: flower,Confidence: 99.0562}</code>
|
|
390
|
-
* </p>
|
|
391
|
-
* <p>
|
|
392
|
-
* <code>{Name: plant,Confidence: 99.0562}</code>
|
|
393
|
-
* </p>
|
|
394
|
-
* <p>
|
|
395
|
-
* <code>{Name: tulip,Confidence: 99.0562}</code>
|
|
396
|
-
* </p>
|
|
397
|
-
*
|
|
398
|
-
* <p>In this example, the detection algorithm more precisely identifies the flower as a
|
|
399
|
-
* tulip.</p>
|
|
400
|
-
* <p>In response, the API returns an array of labels. In addition, the response also
|
|
401
|
-
* includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to
|
|
402
|
-
* control the confidence threshold for the labels returned. The default is 55%. You can also add
|
|
403
|
-
* the <code>MaxLabels</code> parameter to limit the number of labels returned. </p>
|
|
404
|
-
* <note>
|
|
405
|
-
* <p>If the object detected is a person, the operation doesn't provide the same facial
|
|
406
|
-
* details that the <a>DetectFaces</a> operation provides.</p>
|
|
407
|
-
* </note>
|
|
408
|
-
* <p>
|
|
409
|
-
* <code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of
|
|
410
|
-
* <a>Instance</a> objects. An <code>Instance</code> object contains a
|
|
411
|
-
* <a>BoundingBox</a> object, for the location of the label on the image. It also includes
|
|
412
|
-
* the confidence by which the bounding box was detected.</p>
|
|
413
|
-
* <p>
|
|
414
|
-
* <code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example,
|
|
415
|
-
* a detected car might be assigned the label <i>car</i>. The label <i>car</i>
|
|
416
|
-
* has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its
|
|
417
|
-
* grandparent).
|
|
418
|
-
* The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.
|
|
419
|
-
* In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i>
|
|
420
|
-
* are returned as unique labels in the response.
|
|
421
|
-
* </p>
|
|
422
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
423
|
-
* data.</p>
|
|
424
|
-
* <p>This operation requires permissions to perform the
|
|
425
|
-
* <code>rekognition:DetectLabels</code> action. </p>
|
|
426
|
-
*/
|
|
120
|
+
|
|
427
121
|
detectLabels(args: DetectLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectLabelsCommandOutput>;
|
|
428
122
|
detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
429
123
|
detectLabels(args: DetectLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
430
|
-
|
|
431
|
-
* <p>Detects unsafe content in a specified JPEG or PNG format image.
|
|
432
|
-
* Use <code>DetectModerationLabels</code> to moderate images depending on your requirements.
|
|
433
|
-
* For example, you might want to filter images that contain nudity, but not images containing
|
|
434
|
-
* suggestive content.</p>
|
|
435
|
-
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code>
|
|
436
|
-
* to determine which types of content are appropriate.</p>
|
|
437
|
-
*
|
|
438
|
-
* <p>For information about moderation labels,
|
|
439
|
-
* see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>
|
|
440
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
441
|
-
* image in an Amazon S3 bucket. If you use the
|
|
442
|
-
* AWS
|
|
443
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
444
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
445
|
-
*/
|
|
124
|
+
|
|
446
125
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectModerationLabelsCommandOutput>;
|
|
447
126
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
448
127
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
449
|
-
|
|
450
|
-
* <p>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the
|
|
451
|
-
* following types of PPE.</p>
|
|
452
|
-
* <ul>
|
|
453
|
-
* <li>
|
|
454
|
-
* <p>Face cover</p>
|
|
455
|
-
* </li>
|
|
456
|
-
* <li>
|
|
457
|
-
* <p>Hand cover</p>
|
|
458
|
-
* </li>
|
|
459
|
-
* <li>
|
|
460
|
-
* <p>Head cover</p>
|
|
461
|
-
* </li>
|
|
462
|
-
* </ul>
|
|
463
|
-
*
|
|
464
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
|
|
465
|
-
* The image must be either a PNG or JPG formatted file. </p>
|
|
466
|
-
*
|
|
467
|
-
* <p>
|
|
468
|
-
* <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>
|
|
469
|
-
* <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).
|
|
470
|
-
* For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE
|
|
471
|
-
* covers the body part. The API returns the confidence it has in each detection
|
|
472
|
-
* (person, PPE, body part and body part coverage). It also returns a bounding box (<a>BoundingBox</a>) for each detected
|
|
473
|
-
* person and each detected item of PPE. </p>
|
|
474
|
-
* <p>You can optionally request a summary of detected PPE items with the <code>SummarizationAttributes</code> input parameter.
|
|
475
|
-
* The summary provides the following information. </p>
|
|
476
|
-
* <ul>
|
|
477
|
-
* <li>
|
|
478
|
-
* <p>The persons detected as wearing all of the types of PPE that you specify.</p>
|
|
479
|
-
* </li>
|
|
480
|
-
* <li>
|
|
481
|
-
* <p>The persons detected as not wearing all of the types PPE that you specify.</p>
|
|
482
|
-
* </li>
|
|
483
|
-
* <li>
|
|
484
|
-
* <p>The persons detected where PPE adornment could not be determined. </p>
|
|
485
|
-
* </li>
|
|
486
|
-
* </ul>
|
|
487
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any data.</p>
|
|
488
|
-
*
|
|
489
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>
|
|
490
|
-
*/
|
|
128
|
+
|
|
491
129
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options?: __HttpHandlerOptions): Promise<DetectProtectiveEquipmentCommandOutput>;
|
|
492
130
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
493
131
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
494
|
-
|
|
495
|
-
* <p>Detects text in the input image and converts it into machine-readable text.</p>
|
|
496
|
-
* <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an
|
|
497
|
-
* Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
|
|
498
|
-
* reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not
|
|
499
|
-
* supported. The image must be either a .png or .jpeg formatted file. </p>
|
|
500
|
-
* <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each
|
|
501
|
-
* <code>TextDetection</code> element provides information about a single word or line of text
|
|
502
|
-
* that was detected in the image. </p>
|
|
503
|
-
* <p>A word is one or more ISO basic latin script characters that are not separated by spaces.
|
|
504
|
-
* <code>DetectText</code> can detect up to 100 words in an image.</p>
|
|
505
|
-
* <p>A line is a string of equally spaced words. A line isn't necessarily a complete
|
|
506
|
-
* sentence. For example, a driver's license number is detected as a line. A line ends when there
|
|
507
|
-
* is no aligned text after it. Also, a line ends when there is a large gap between words,
|
|
508
|
-
* relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition
|
|
509
|
-
* may detect multiple lines in text aligned in the same direction. Periods don't represent the
|
|
510
|
-
* end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation
|
|
511
|
-
* returns multiple lines.</p>
|
|
512
|
-
* <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,
|
|
513
|
-
* use the <code>TextDetection</code> object <code>Type</code> field. </p>
|
|
514
|
-
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>
|
|
515
|
-
*
|
|
516
|
-
* <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>
|
|
517
|
-
*/
|
|
132
|
+
|
|
518
133
|
detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise<DetectTextCommandOutput>;
|
|
519
134
|
detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
520
135
|
detectText(args: DetectTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
521
|
-
|
|
522
|
-
* <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
|
|
523
|
-
* The additional information is returned as an array of URLs. If there is no additional
|
|
524
|
-
* information about the celebrity, this list is empty.</p>
|
|
525
|
-
*
|
|
526
|
-
* <p>For more information, see Recognizing Celebrities in an Image in
|
|
527
|
-
* the Amazon Rekognition Developer Guide.</p>
|
|
528
|
-
* <p>This operation requires permissions to perform the
|
|
529
|
-
* <code>rekognition:GetCelebrityInfo</code> action. </p>
|
|
530
|
-
*/
|
|
136
|
+
|
|
531
137
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, options?: __HttpHandlerOptions): Promise<GetCelebrityInfoCommandOutput>;
|
|
532
138
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
533
139
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
534
|
-
|
|
535
|
-
* <p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
|
|
536
|
-
* <a>StartCelebrityRecognition</a>.</p>
|
|
537
|
-
* <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call
|
|
538
|
-
* to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>).
|
|
539
|
-
* When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
|
|
540
|
-
* topic registered in the initial call to <code>StartCelebrityRecognition</code>.
|
|
541
|
-
* To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
|
|
542
|
-
* topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job identifier
|
|
543
|
-
* (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
|
|
544
|
-
*
|
|
545
|
-
* <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
|
|
546
|
-
* <p>
|
|
547
|
-
* <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they are detected in an array
|
|
548
|
-
* (<code>Celebrities</code>) of <a>CelebrityRecognition</a>
|
|
549
|
-
* objects. Each <code>CelebrityRecognition</code> contains information about the celebrity in a <a>CelebrityDetail</a>
|
|
550
|
-
* object and the time, <code>Timestamp</code>, the celebrity was detected.
|
|
551
|
-
* </p>
|
|
552
|
-
* <note>
|
|
553
|
-
* <p>
|
|
554
|
-
* <code>GetCelebrityRecognition</code> only returns the default
|
|
555
|
-
* facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
|
|
556
|
-
* <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
|
|
557
|
-
* in the <code>Face</code> object of the following response syntax are not returned. For more information,
|
|
558
|
-
* see FaceDetail in the Amazon Rekognition Developer Guide. </p>
|
|
559
|
-
* </note>
|
|
560
|
-
* <p>By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video).
|
|
561
|
-
* You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter.</p>
|
|
562
|
-
* <p>The <code>CelebrityDetail</code> object includes the celebrity identifer and additional information urls. If you don't store
|
|
563
|
-
* the additional information urls, you can get them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer.</p>
|
|
564
|
-
* <p>No information is returned for faces not recognized as celebrities.</p>
|
|
565
|
-
* <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
|
|
566
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a
|
|
567
|
-
* pagination token for getting the next set of results. To get the next page of results, call <code>GetCelebrityDetection</code>
|
|
568
|
-
* and populate the <code>NextToken</code> request parameter with the token
|
|
569
|
-
* value returned from the previous call to <code>GetCelebrityRecognition</code>.</p>
|
|
570
|
-
*/
|
|
140
|
+
|
|
571
141
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<GetCelebrityRecognitionCommandOutput>;
|
|
572
142
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
573
143
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
574
|
-
|
|
575
|
-
* <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
|
|
576
|
-
* <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
|
|
577
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
578
|
-
*
|
|
579
|
-
* <p>Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling
|
|
580
|
-
* <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).
|
|
581
|
-
* When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
|
|
582
|
-
* topic registered in the initial call to <code>StartContentModeration</code>.
|
|
583
|
-
* To get the results of the content analysis, first check that the status value published to the Amazon SNS
|
|
584
|
-
* topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier
|
|
585
|
-
* (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
|
|
586
|
-
*
|
|
587
|
-
* <p>For more information, see Working with Stored Videos in the
|
|
588
|
-
* Amazon Rekognition Devlopers Guide.</p>
|
|
589
|
-
* <p>
|
|
590
|
-
* <code>GetContentModeration</code> returns detected inappropriate, unwanted, or offensive content moderation labels,
|
|
591
|
-
* and the time they are detected, in an array, <code>ModerationLabels</code>, of
|
|
592
|
-
* <a>ContentModerationDetection</a> objects.
|
|
593
|
-
* </p>
|
|
594
|
-
* <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the
|
|
595
|
-
* video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code>
|
|
596
|
-
* input parameter. </p>
|
|
597
|
-
* <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit
|
|
598
|
-
* the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than
|
|
599
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a
|
|
600
|
-
* pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>
|
|
601
|
-
* and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
|
|
602
|
-
* returned from the previous call to <code>GetContentModeration</code>.</p>
|
|
603
|
-
*
|
|
604
|
-
* <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>
|
|
605
|
-
*/
|
|
144
|
+
|
|
606
145
|
getContentModeration(args: GetContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<GetContentModerationCommandOutput>;
|
|
607
146
|
getContentModeration(args: GetContentModerationCommandInput, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
608
147
|
getContentModeration(args: GetContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
609
|
-
|
|
610
|
-
* <p>Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>.</p>
|
|
611
|
-
* <p>Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a>
|
|
612
|
-
* which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
613
|
-
* the Amazon Simple Notification Service topic registered in the initial call to <code>StartFaceDetection</code>. To get the results
|
|
614
|
-
* of the face detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
615
|
-
* If so, call <a>GetFaceDetection</a> and pass the job identifier
|
|
616
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
|
|
617
|
-
* <p>
|
|
618
|
-
* <code>GetFaceDetection</code> returns an array of detected faces (<code>Faces</code>) sorted by the time the faces were detected. </p>
|
|
619
|
-
* <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
|
|
620
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
|
|
621
|
-
* of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token
|
|
622
|
-
* value returned from the previous call to <code>GetFaceDetection</code>.</p>
|
|
623
|
-
*/
|
|
148
|
+
|
|
624
149
|
getFaceDetection(args: GetFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceDetectionCommandOutput>;
|
|
625
150
|
getFaceDetection(args: GetFaceDetectionCommandInput, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
626
151
|
getFaceDetection(args: GetFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
627
|
-
|
|
628
|
-
* <p>Gets the face search results for Amazon Rekognition Video face search started by
|
|
629
|
-
* <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces
|
|
630
|
-
* of persons detected in a video. It also includes the time(s) that faces are matched in the video.</p>
|
|
631
|
-
* <p>Face search in a video is an asynchronous operation. You start face search by calling
|
|
632
|
-
* to <a>StartFaceSearch</a> which returns a job identifier (<code>JobId</code>).
|
|
633
|
-
* When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
|
|
634
|
-
* topic registered in the initial call to <code>StartFaceSearch</code>.
|
|
635
|
-
* To get the search results, first check that the status value published to the Amazon SNS
|
|
636
|
-
* topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier
|
|
637
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>.</p>
|
|
638
|
-
*
|
|
639
|
-
* <p>For more information, see Searching Faces in a Collection in the
|
|
640
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
641
|
-
* <p>The search results are retured in an array, <code>Persons</code>, of
|
|
642
|
-
* <a>PersonMatch</a> objects. Each<code>PersonMatch</code> element contains
|
|
643
|
-
* details about the matching faces in the input collection, person information (facial attributes,
|
|
644
|
-
* bounding boxes, and person identifer)
|
|
645
|
-
* for the matched person, and the time the person was matched in the video.</p>
|
|
646
|
-
* <note>
|
|
647
|
-
* <p>
|
|
648
|
-
* <code>GetFaceSearch</code> only returns the default
|
|
649
|
-
* facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
|
|
650
|
-
* <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
|
|
651
|
-
* in the <code>Face</code> object of the following response syntax are not returned. For more information,
|
|
652
|
-
* see FaceDetail in the Amazon Rekognition Developer Guide. </p>
|
|
653
|
-
* </note>
|
|
654
|
-
*
|
|
655
|
-
* <p>By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the
|
|
656
|
-
* start of the video, persons are matched.
|
|
657
|
-
* You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input
|
|
658
|
-
* parameter.</p>
|
|
659
|
-
*/
|
|
152
|
+
|
|
660
153
|
getFaceSearch(args: GetFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceSearchCommandOutput>;
|
|
661
154
|
getFaceSearch(args: GetFaceSearchCommandInput, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
662
155
|
getFaceSearch(args: GetFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
663
|
-
|
|
664
|
-
* <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
|
|
665
|
-
*
|
|
666
|
-
* <p>The label detection operation is started by a call to <a>StartLabelDetection</a>
|
|
667
|
-
* which returns a job identifier (<code>JobId</code>). When the label detection operation finishes, Amazon Rekognition publishes a completion status to
|
|
668
|
-
* the Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. To get the results
|
|
669
|
-
* of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
670
|
-
* If so, call <a>GetLabelDetection</a> and pass the job identifier
|
|
671
|
-
* (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
|
|
672
|
-
* <p>
|
|
673
|
-
* <code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) sorted by the time
|
|
674
|
-
* the labels were detected. You can also sort by the label name by specifying <code>NAME</code> for the
|
|
675
|
-
* <code>SortBy</code> input parameter.</p>
|
|
676
|
-
* <p>The labels returned include the label name, the percentage confidence in the accuracy of the detected label,
|
|
677
|
-
* and the time the label was detected in the video.</p>
|
|
678
|
-
* <p>The returned labels also include bounding box information for common objects, a
|
|
679
|
-
* hierarchical taxonomy of detected labels, and the version of the label model used for detection.</p>
|
|
680
|
-
*
|
|
681
|
-
* <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
|
|
682
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
|
|
683
|
-
* of results. To get the next page of results, call <code>GetlabelDetection</code> and populate the <code>NextToken</code> request parameter with the token
|
|
684
|
-
* value returned from the previous call to <code>GetLabelDetection</code>.</p>
|
|
685
|
-
*/
|
|
156
|
+
|
|
686
157
|
getLabelDetection(args: GetLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetLabelDetectionCommandOutput>;
|
|
687
158
|
getLabelDetection(args: GetLabelDetectionCommandInput, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
688
159
|
getLabelDetection(args: GetLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
689
|
-
|
|
690
|
-
* <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
|
|
691
|
-
*
|
|
692
|
-
* <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
|
|
693
|
-
* which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
694
|
-
* the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>
|
|
695
|
-
* <p>To get the results of the person path tracking operation, first check
|
|
696
|
-
* that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
697
|
-
* If so, call <a>GetPersonTracking</a> and pass the job identifier
|
|
698
|
-
* (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>
|
|
699
|
-
* <p>
|
|
700
|
-
* <code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked persons and the time(s) their
|
|
701
|
-
* paths were tracked in the video. </p>
|
|
702
|
-
* <note>
|
|
703
|
-
* <p>
|
|
704
|
-
* <code>GetPersonTracking</code> only returns the default
|
|
705
|
-
* facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
|
|
706
|
-
* <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
|
|
707
|
-
* in the <code>Face</code> object of the following response syntax are not returned. </p>
|
|
708
|
-
*
|
|
709
|
-
* <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p>
|
|
710
|
-
* </note>
|
|
711
|
-
*
|
|
712
|
-
*
|
|
713
|
-
* <p>By default, the array is sorted by the time(s) a person's path is tracked in the video.
|
|
714
|
-
* You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p>
|
|
715
|
-
*
|
|
716
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than
|
|
717
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
|
|
718
|
-
* of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token
|
|
719
|
-
* value returned from the previous call to <code>GetPersonTracking</code>.</p>
|
|
720
|
-
*/
|
|
160
|
+
|
|
721
161
|
getPersonTracking(args: GetPersonTrackingCommandInput, options?: __HttpHandlerOptions): Promise<GetPersonTrackingCommandOutput>;
|
|
722
162
|
getPersonTracking(args: GetPersonTrackingCommandInput, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
723
163
|
getPersonTracking(args: GetPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
724
|
-
|
|
725
|
-
* <p>Gets the segment detection results of a Amazon Rekognition Video analysis started by <a>StartSegmentDetection</a>.</p>
|
|
726
|
-
* <p>Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
|
|
727
|
-
* calling <a>StartSegmentDetection</a> which returns a job identifier (<code>JobId</code>).
|
|
728
|
-
* When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
|
|
729
|
-
* topic registered in the initial call to <code>StartSegmentDetection</code>. To get the results
|
|
730
|
-
* of the segment detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
731
|
-
* if so, call <code>GetSegmentDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call
|
|
732
|
-
* of <code>StartSegmentDetection</code>.</p>
|
|
733
|
-
* <p>
|
|
734
|
-
* <code>GetSegmentDetection</code> returns detected segments in an array (<code>Segments</code>)
|
|
735
|
-
* of <a>SegmentDetection</a> objects. <code>Segments</code> is sorted by the segment types
|
|
736
|
-
* specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>.
|
|
737
|
-
* Each element of the array includes the detected segment, the precentage confidence in the acuracy
|
|
738
|
-
* of the detected segment, the type of the segment, and the frame in which the segment was detected.</p>
|
|
739
|
-
* <p>Use <code>SelectedSegmentTypes</code> to find out the type of segment detection requested in the
|
|
740
|
-
* call to <code>StartSegmentDetection</code>.</p>
|
|
741
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of segment detections returned. If there are more results than
|
|
742
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains
|
|
743
|
-
* a pagination token for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code>
|
|
744
|
-
* and populate the <code>NextToken</code> request parameter with the token value returned from the previous
|
|
745
|
-
* call to <code>GetSegmentDetection</code>.</p>
|
|
746
|
-
*
|
|
747
|
-
* <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>
|
|
748
|
-
*/
|
|
164
|
+
|
|
749
165
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetSegmentDetectionCommandOutput>;
|
|
750
166
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
751
167
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
752
|
-
|
|
753
|
-
* <p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p>
|
|
754
|
-
* <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
|
|
755
|
-
* calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>)
|
|
756
|
-
* When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
|
|
757
|
-
* topic registered in the initial call to <code>StartTextDetection</code>. To get the results
|
|
758
|
-
* of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
759
|
-
* if so, call <code>GetTextDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call
|
|
760
|
-
* of <code>StartLabelDetection</code>.</p>
|
|
761
|
-
* <p>
|
|
762
|
-
* <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by
|
|
763
|
-
* the time the text was detected, up to 50 words per frame of video.</p>
|
|
764
|
-
* <p>Each element of the array includes the detected text, the precentage confidence in the acuracy
|
|
765
|
-
* of the detected text, the time the text was detected, bounding box information for where the text
|
|
766
|
-
* was located, and unique identifiers for words and their lines.</p>
|
|
767
|
-
* <p>Use MaxResults parameter to limit the number of text detections returned. If there are more results than
|
|
768
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains
|
|
769
|
-
* a pagination token for getting the next set of results. To get the next page of results, call <code>GetTextDetection</code>
|
|
770
|
-
* and populate the <code>NextToken</code> request parameter with the token value returned from the previous
|
|
771
|
-
* call to <code>GetTextDetection</code>.</p>
|
|
772
|
-
*/
|
|
168
|
+
|
|
773
169
|
getTextDetection(args: GetTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetTextDetectionCommandOutput>;
|
|
774
170
|
getTextDetection(args: GetTextDetectionCommandInput, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
775
171
|
getTextDetection(args: GetTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
776
|
-
|
|
777
|
-
* <p>Detects faces in the input image and adds them to the specified collection. </p>
|
|
778
|
-
* <p>Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying
|
|
779
|
-
* detection algorithm first detects the faces in the input image. For each face, the algorithm
|
|
780
|
-
* extracts facial features into a feature vector, and stores it in the backend database.
|
|
781
|
-
* Amazon Rekognition uses feature vectors when it performs face match and search operations using the
|
|
782
|
-
* <a>SearchFaces</a> and <a>SearchFacesByImage</a>
|
|
783
|
-
* operations.</p>
|
|
784
|
-
*
|
|
785
|
-
* <p>For more information, see Adding Faces to a Collection in the Amazon Rekognition
|
|
786
|
-
* Developer Guide.</p>
|
|
787
|
-
* <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
|
|
788
|
-
*
|
|
789
|
-
* <p>If you're using version 1.0 of the face detection model, <code>IndexFaces</code>
|
|
790
|
-
* indexes the 15 largest faces in the input image. Later versions of the face detection model
|
|
791
|
-
* index the 100 largest faces in the input image. </p>
|
|
792
|
-
* <p>If you're using version 4 or later of the face model, image orientation information
|
|
793
|
-
* is not returned in the <code>OrientationCorrection</code> field. </p>
|
|
794
|
-
* <p>To determine which version of the model you're using, call <a>DescribeCollection</a>
|
|
795
|
-
* and supply the collection ID. You can also get the model version from the value of <code>FaceModelVersion</code> in the response
|
|
796
|
-
* from <code>IndexFaces</code>
|
|
797
|
-
* </p>
|
|
798
|
-
*
|
|
799
|
-
* <p>For more information, see Model Versioning in the Amazon Rekognition Developer
|
|
800
|
-
* Guide.</p>
|
|
801
|
-
* <p>If you provide the optional <code>ExternalImageId</code> for the input image you
|
|
802
|
-
* provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the <a>ListFaces</a> operation, the response returns the external ID. You can use this
|
|
803
|
-
* external image ID to create a client-side index to associate the faces with each image. You
|
|
804
|
-
* can then use the index to find all faces in an image.</p>
|
|
805
|
-
* <p>You can specify the maximum number of faces to index with the <code>MaxFaces</code> input
|
|
806
|
-
* parameter. This is useful when you want to index the largest faces in an image and don't want to index
|
|
807
|
-
* smaller faces, such as those belonging to people standing in the background.</p>
|
|
808
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
809
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
810
|
-
* variety of common use cases. By default, <code>IndexFaces</code> chooses the quality bar that's
|
|
811
|
-
* used to filter faces. You can also explicitly choose
|
|
812
|
-
* the quality bar. Use <code>QualityFilter</code>, to set the quality bar
|
|
813
|
-
* by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
|
|
814
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
815
|
-
* <note>
|
|
816
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
817
|
-
* face model or higher. To get the version of the face model associated with a collection, call
|
|
818
|
-
* <a>DescribeCollection</a>. </p>
|
|
819
|
-
* </note>
|
|
820
|
-
* <p>Information about faces detected in an image, but not indexed, is returned in an array of
|
|
821
|
-
* <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't
|
|
822
|
-
* indexed for reasons such as:</p>
|
|
823
|
-
* <ul>
|
|
824
|
-
* <li>
|
|
825
|
-
* <p>The number of faces detected exceeds the value of the <code>MaxFaces</code> request
|
|
826
|
-
* parameter.</p>
|
|
827
|
-
* </li>
|
|
828
|
-
* <li>
|
|
829
|
-
* <p>The face is too small compared to the image dimensions.</p>
|
|
830
|
-
* </li>
|
|
831
|
-
* <li>
|
|
832
|
-
* <p>The face is too blurry.</p>
|
|
833
|
-
* </li>
|
|
834
|
-
* <li>
|
|
835
|
-
* <p>The image is too dark.</p>
|
|
836
|
-
* </li>
|
|
837
|
-
* <li>
|
|
838
|
-
* <p>The face has an extreme pose.</p>
|
|
839
|
-
* </li>
|
|
840
|
-
* <li>
|
|
841
|
-
* <p>The face doesn’t have enough detail to be suitable for face search.</p>
|
|
842
|
-
* </li>
|
|
843
|
-
* </ul>
|
|
844
|
-
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for
|
|
845
|
-
* all detected faces, <code>FaceRecords</code>. This includes: </p>
|
|
846
|
-
* <ul>
|
|
847
|
-
* <li>
|
|
848
|
-
* <p>The bounding box, <code>BoundingBox</code>, of the detected face. </p>
|
|
849
|
-
* </li>
|
|
850
|
-
* <li>
|
|
851
|
-
* <p>A confidence value, <code>Confidence</code>, which indicates the confidence that the
|
|
852
|
-
* bounding box contains a face.</p>
|
|
853
|
-
* </li>
|
|
854
|
-
* <li>
|
|
855
|
-
* <p>A face ID, <code>FaceId</code>, assigned by the service for each face that's detected
|
|
856
|
-
* and stored.</p>
|
|
857
|
-
* </li>
|
|
858
|
-
* <li>
|
|
859
|
-
* <p>An image ID, <code>ImageId</code>, assigned by the service for the input image.</p>
|
|
860
|
-
* </li>
|
|
861
|
-
* </ul>
|
|
862
|
-
* <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
|
|
863
|
-
* parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
|
|
864
|
-
* example, location of eye and mouth) and other facial attributes. If you provide
|
|
865
|
-
* the same image, specify the same collection, and use the same external ID in the
|
|
866
|
-
* <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
|
|
867
|
-
*
|
|
868
|
-
*
|
|
869
|
-
* <p></p>
|
|
870
|
-
*
|
|
871
|
-
*
|
|
872
|
-
* <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
|
|
873
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
874
|
-
* passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
875
|
-
* <p>This operation requires permissions to perform the <code>rekognition:IndexFaces</code>
|
|
876
|
-
* action.</p>
|
|
877
|
-
*/
|
|
172
|
+
|
|
878
173
|
indexFaces(args: IndexFacesCommandInput, options?: __HttpHandlerOptions): Promise<IndexFacesCommandOutput>;
|
|
879
174
|
indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
880
175
|
indexFaces(args: IndexFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
881
|
-
|
|
882
|
-
* <p>Returns list of collection IDs in your account.
|
|
883
|
-
* If the result is truncated, the response also provides a <code>NextToken</code>
|
|
884
|
-
* that you can use in the subsequent request to fetch the next set of collection IDs.</p>
|
|
885
|
-
*
|
|
886
|
-
* <p>For an example, see Listing Collections in the Amazon Rekognition Developer Guide.</p>
|
|
887
|
-
* <p>This operation requires permissions to perform the <code>rekognition:ListCollections</code> action.</p>
|
|
888
|
-
*/
|
|
176
|
+
|
|
889
177
|
listCollections(args: ListCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCollectionsCommandOutput>;
|
|
890
178
|
listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
891
179
|
listCollections(args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
892
|
-
|
|
893
|
-
* <p>Returns metadata for faces in the specified collection.
|
|
894
|
-
* This metadata includes information such as the bounding box coordinates, the confidence
|
|
895
|
-
* (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection
|
|
896
|
-
* in the Amazon Rekognition Developer Guide.</p>
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
* <p>This operation requires permissions to perform the
|
|
900
|
-
* <code>rekognition:ListFaces</code> action.</p>
|
|
901
|
-
*/
|
|
180
|
+
|
|
902
181
|
listFaces(args: ListFacesCommandInput, options?: __HttpHandlerOptions): Promise<ListFacesCommandOutput>;
|
|
903
182
|
listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
904
183
|
listFaces(args: ListFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
905
|
-
|
|
906
|
-
* <p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>
|
|
907
|
-
*/
|
|
184
|
+
|
|
908
185
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamProcessorsCommandOutput>;
|
|
909
186
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
910
187
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
911
|
-
|
|
912
|
-
* <p>
|
|
913
|
-
* Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
914
|
-
* </p>
|
|
915
|
-
* <p>This operation requires permissions to perform the
|
|
916
|
-
* <code>rekognition:ListTagsForResource</code> action. </p>
|
|
917
|
-
*/
|
|
188
|
+
|
|
918
189
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
919
190
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
920
191
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
921
|
-
|
|
922
|
-
* <p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities
|
|
923
|
-
* in the Amazon Rekognition Developer Guide. </p>
|
|
924
|
-
* <p>
|
|
925
|
-
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
926
|
-
* recognized celebrities in the <code>CelebrityFaces</code> array and unrecognized faces in the
|
|
927
|
-
* <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
928
|
-
* celebrities whose faces aren't among the largest 64 faces in the image.</p>
|
|
929
|
-
*
|
|
930
|
-
* <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
|
|
931
|
-
* <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity
|
|
932
|
-
* name, ID, URL links to additional information, match confidence, and a
|
|
933
|
-
* <code>ComparedFace</code> object that you can use to locate the celebrity's face on the
|
|
934
|
-
* image.</p>
|
|
935
|
-
* <p>Amazon Rekognition doesn't retain information about which images a celebrity has been recognized
|
|
936
|
-
* in. Your application must store this information and use the <code>Celebrity</code> ID
|
|
937
|
-
* property as a unique identifier for the celebrity. If you don't store the celebrity name or
|
|
938
|
-
* additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the
|
|
939
|
-
* ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a>
|
|
940
|
-
* operation.</p>
|
|
941
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
942
|
-
* image in an Amazon S3 bucket. If you use the
|
|
943
|
-
* AWS
|
|
944
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
945
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
946
|
-
*
|
|
947
|
-
*
|
|
948
|
-
*
|
|
949
|
-
*
|
|
950
|
-
* <p>For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.</p>
|
|
951
|
-
* <p>This operation requires permissions to perform the
|
|
952
|
-
* <code>rekognition:RecognizeCelebrities</code> operation.</p>
|
|
953
|
-
*/
|
|
192
|
+
|
|
954
193
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, options?: __HttpHandlerOptions): Promise<RecognizeCelebritiesCommandOutput>;
|
|
955
194
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
956
195
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
957
|
-
|
|
958
|
-
* <p>For a given input face ID, searches for matching faces in the collection the face
|
|
959
|
-
* belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with
|
|
960
|
-
* faces in the specified collection. </p>
|
|
961
|
-
* <note>
|
|
962
|
-
* <p>You can also search faces without indexing faces by using the
|
|
963
|
-
* <code>SearchFacesByImage</code> operation.</p>
|
|
964
|
-
* </note>
|
|
965
|
-
*
|
|
966
|
-
* <p>
|
|
967
|
-
* The operation response returns
|
|
968
|
-
* an array of faces that match, ordered by similarity score with the highest
|
|
969
|
-
* similarity first. More specifically, it is an
|
|
970
|
-
* array of metadata for each face match that is found. Along with the metadata, the response also
|
|
971
|
-
* includes a <code>confidence</code> value for each face match, indicating the confidence
|
|
972
|
-
* that the specific face matches the input face.
|
|
973
|
-
* </p>
|
|
974
|
-
*
|
|
975
|
-
* <p>For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.</p>
|
|
976
|
-
*
|
|
977
|
-
* <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
|
|
978
|
-
* action.</p>
|
|
979
|
-
*/
|
|
196
|
+
|
|
980
197
|
searchFaces(args: SearchFacesCommandInput, options?: __HttpHandlerOptions): Promise<SearchFacesCommandOutput>;
|
|
981
198
|
searchFaces(args: SearchFacesCommandInput, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
982
199
|
searchFaces(args: SearchFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
983
|
-
|
|
984
|
-
* <p>For a given input image, first detects the largest face in the image, and then searches
|
|
985
|
-
* the specified collection for matching faces. The operation compares the features of the input
|
|
986
|
-
* face with faces in the specified collection. </p>
|
|
987
|
-
* <note>
|
|
988
|
-
* <p>To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent
|
|
989
|
-
* calls to the <a>SearchFaces</a> operation. </p>
|
|
990
|
-
* <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes
|
|
991
|
-
* in the response to make face crops, which then you can pass in to the
|
|
992
|
-
* <code>SearchFacesByImage</code> operation. </p>
|
|
993
|
-
* </note>
|
|
994
|
-
*
|
|
995
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
996
|
-
* image in an Amazon S3 bucket. If you use the
|
|
997
|
-
* AWS
|
|
998
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
999
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
1000
|
-
* <p>
|
|
1001
|
-
* The response returns an array of faces that match, ordered by similarity score with the
|
|
1002
|
-
* highest similarity first. More specifically, it is an
|
|
1003
|
-
* array of metadata for each face match found. Along with the metadata, the response also
|
|
1004
|
-
* includes a <code>similarity</code> indicating how similar the face is
|
|
1005
|
-
* to the input face.
|
|
1006
|
-
*
|
|
1007
|
-
* In the response, the operation also returns the bounding
|
|
1008
|
-
* box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition
|
|
1009
|
-
* used for the input image.
|
|
1010
|
-
* </p>
|
|
1011
|
-
* <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
|
|
1012
|
-
* <code>InvalidParameterException</code> error. </p>
|
|
1013
|
-
*
|
|
1014
|
-
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.</p>
|
|
1015
|
-
*
|
|
1016
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
1017
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
1018
|
-
* variety of common use cases.
|
|
1019
|
-
* Use <code>QualityFilter</code> to set the quality bar for
|
|
1020
|
-
* filtering by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
|
|
1021
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. The default
|
|
1022
|
-
* value is <code>NONE</code>.</p>
|
|
1023
|
-
* <note>
|
|
1024
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the
|
|
1025
|
-
* face model or higher. To get the version of the face model associated with a collection, call
|
|
1026
|
-
* <a>DescribeCollection</a>. </p>
|
|
1027
|
-
* </note>
|
|
1028
|
-
*
|
|
1029
|
-
* <p>This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code>
|
|
1030
|
-
* action.</p>
|
|
1031
|
-
*/
|
|
200
|
+
|
|
1032
201
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options?: __HttpHandlerOptions): Promise<SearchFacesByImageCommandOutput>;
|
|
1033
202
|
searchFacesByImage(args: SearchFacesByImageCommandInput, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1034
203
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1035
|
-
|
|
1036
|
-
* <p>Starts asynchronous recognition of celebrities in a stored video.</p>
|
|
1037
|
-
* <p>Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1038
|
-
* and the filename of the video.
|
|
1039
|
-
* <code>StartCelebrityRecognition</code>
|
|
1040
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
|
|
1041
|
-
* When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status
|
|
1042
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1043
|
-
* To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
|
|
1044
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
|
|
1045
|
-
* (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
|
|
1046
|
-
*
|
|
1047
|
-
* <p>For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.</p>
|
|
1048
|
-
*/
|
|
204
|
+
|
|
1049
205
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<StartCelebrityRecognitionCommandOutput>;
|
|
1050
206
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1051
207
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1052
|
-
|
|
1053
|
-
* <p> Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see
|
|
1054
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
1055
|
-
* <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1056
|
-
* and the filename of the video. <code>StartContentModeration</code>
|
|
1057
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
|
|
1058
|
-
* When content analysis is finished, Amazon Rekognition Video publishes a completion status
|
|
1059
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
|
|
1060
|
-
* <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
|
|
1061
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
|
|
1062
|
-
* (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
|
|
1063
|
-
*
|
|
1064
|
-
* <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>
|
|
1065
|
-
*/
|
|
208
|
+
|
|
1066
209
|
startContentModeration(args: StartContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<StartContentModerationCommandOutput>;
|
|
1067
210
|
startContentModeration(args: StartContentModerationCommandInput, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1068
211
|
startContentModeration(args: StartContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1069
|
-
|
|
1070
|
-
* <p>Starts asynchronous detection of faces in a stored video.</p>
|
|
1071
|
-
* <p>Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.
|
|
1072
|
-
* Use <a>Video</a> to specify the bucket name and the filename of the video.
|
|
1073
|
-
* <code>StartFaceDetection</code> returns a job identifier (<code>JobId</code>) that you
|
|
1074
|
-
* use to get the results of the operation.
|
|
1075
|
-
* When face detection is finished, Amazon Rekognition Video publishes a completion status
|
|
1076
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1077
|
-
* To get the results of the face detection operation, first check that the status value published to the Amazon SNS
|
|
1078
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
|
|
1079
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
|
|
1080
|
-
*
|
|
1081
|
-
* <p>For more information, see Detecting Faces in a Stored Video in the
|
|
1082
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
1083
|
-
*/
|
|
212
|
+
|
|
1084
213
|
startFaceDetection(args: StartFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceDetectionCommandOutput>;
|
|
1085
214
|
startFaceDetection(args: StartFaceDetectionCommandInput, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1086
215
|
startFaceDetection(args: StartFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1087
|
-
|
|
1088
|
-
* <p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>
|
|
1089
|
-
* <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1090
|
-
* and the filename of the video. <code>StartFaceSearch</code>
|
|
1091
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed.
|
|
1092
|
-
* When searching is finished, Amazon Rekognition Video publishes a completion status
|
|
1093
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1094
|
-
* To get the search results, first check that the status value published to the Amazon SNS
|
|
1095
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier
|
|
1096
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see
|
|
1097
|
-
* <a>procedure-person-search-videos</a>.</p>
|
|
1098
|
-
*/
|
|
216
|
+
|
|
1099
217
|
startFaceSearch(args: StartFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceSearchCommandOutput>;
|
|
1100
218
|
startFaceSearch(args: StartFaceSearchCommandInput, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1101
219
|
startFaceSearch(args: StartFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1102
|
-
|
|
1103
|
-
* <p>Starts asynchronous detection of labels in a stored video.</p>
|
|
1104
|
-
* <p>Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.
|
|
1105
|
-
* This includes objects like flower, tree, and table; events like
|
|
1106
|
-
* wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities
|
|
1107
|
-
* like a person getting out of a car or a person skiing.</p>
|
|
1108
|
-
*
|
|
1109
|
-
* <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1110
|
-
* and the filename of the video.
|
|
1111
|
-
* <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the
|
|
1112
|
-
* results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status
|
|
1113
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
|
|
1114
|
-
* <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS
|
|
1115
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier
|
|
1116
|
-
* (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
|
|
1117
|
-
* <p></p>
|
|
1118
|
-
*/
|
|
220
|
+
|
|
1119
221
|
startLabelDetection(args: StartLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartLabelDetectionCommandOutput>;
|
|
1120
222
|
startLabelDetection(args: StartLabelDetectionCommandInput, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1121
223
|
startLabelDetection(args: StartLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1122
|
-
|
|
1123
|
-
* <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
|
|
1124
|
-
* <p>Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1125
|
-
* and the filename of the video. <code>StartPersonTracking</code>
|
|
1126
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the operation.
|
|
1127
|
-
* When label detection is finished, Amazon Rekognition publishes a completion status
|
|
1128
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </p>
|
|
1129
|
-
* <p>To get the results of the person detection operation, first check that the status value published to the Amazon SNS
|
|
1130
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier
|
|
1131
|
-
* (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>
|
|
1132
|
-
*/
|
|
224
|
+
|
|
1133
225
|
startPersonTracking(args: StartPersonTrackingCommandInput, options?: __HttpHandlerOptions): Promise<StartPersonTrackingCommandOutput>;
|
|
1134
226
|
startPersonTracking(args: StartPersonTrackingCommandInput, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1135
227
|
startPersonTracking(args: StartPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1136
|
-
|
|
1137
|
-
* <p>Starts the running of the version of a model. Starting a model takes a while
|
|
1138
|
-
* to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>
|
|
1139
|
-
* <p>Once the model is running, you can detect custom labels in new images by calling
|
|
1140
|
-
* <a>DetectCustomLabels</a>.</p>
|
|
1141
|
-
* <note>
|
|
1142
|
-
* <p>You are charged for the amount of time that the model is running. To stop a running
|
|
1143
|
-
* model, call <a>StopProjectVersion</a>.</p>
|
|
1144
|
-
* </note>
|
|
1145
|
-
* <p>This operation requires permissions to perform the
|
|
1146
|
-
* <code>rekognition:StartProjectVersion</code> action.</p>
|
|
1147
|
-
*/
|
|
228
|
+
|
|
1148
229
|
startProjectVersion(args: StartProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<StartProjectVersionCommandOutput>;
|
|
1149
230
|
startProjectVersion(args: StartProjectVersionCommandInput, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1150
231
|
startProjectVersion(args: StartProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1151
|
-
|
|
1152
|
-
* <p>Starts asynchronous detection of segment detection in a stored video.</p>
|
|
1153
|
-
* <p>Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1154
|
-
* the filename of the video. <code>StartSegmentDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
1155
|
-
* the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
|
|
1156
|
-
* that you specify in <code>NotificationChannel</code>.</p>
|
|
1157
|
-
* <p>You can use the <code>Filters</code> (<a>StartSegmentDetectionFilters</a>)
|
|
1158
|
-
* input parameter to specify the minimum detection confidence returned in the response.
|
|
1159
|
-
* Within <code>Filters</code>, use <code>ShotFilter</code> (<a>StartShotDetectionFilter</a>)
|
|
1160
|
-
* to filter detected shots. Use <code>TechnicalCueFilter</code> (<a>StartTechnicalCueDetectionFilter</a>)
|
|
1161
|
-
* to filter technical cues. </p>
|
|
1162
|
-
* <p>To get the results of the segment detection operation, first check that the status value published to the Amazon SNS
|
|
1163
|
-
* topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<code>JobId</code>)
|
|
1164
|
-
* from the initial call to <code>StartSegmentDetection</code>. </p>
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
* <p>For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.</p>
|
|
1168
|
-
*/
|
|
232
|
+
|
|
1169
233
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartSegmentDetectionCommandOutput>;
|
|
1170
234
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1171
235
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1172
|
-
|
|
1173
|
-
* <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
|
|
1174
|
-
* To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
|
|
1175
|
-
* <code>CreateStreamProcessor</code>.</p>
|
|
1176
|
-
*/
|
|
236
|
+
|
|
1177
237
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamProcessorCommandOutput>;
|
|
1178
238
|
startStreamProcessor(args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1179
239
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1180
|
-
|
|
1181
|
-
* <p>Starts asynchronous detection of text in a stored video.</p>
|
|
1182
|
-
* <p>Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1183
|
-
* the filename of the video. <code>StartTextDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
1184
|
-
* the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
|
|
1185
|
-
* that you specify in <code>NotificationChannel</code>.</p>
|
|
1186
|
-
* <p>To get the results of the text detection operation, first check that the status value published to the Amazon SNS
|
|
1187
|
-
* topic is <code>SUCCEEDED</code>. if so, call <a>GetTextDetection</a> and pass the job identifier (<code>JobId</code>)
|
|
1188
|
-
* from the initial call to <code>StartTextDetection</code>. </p>
|
|
1189
|
-
*/
|
|
240
|
+
|
|
1190
241
|
startTextDetection(args: StartTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartTextDetectionCommandOutput>;
|
|
1191
242
|
startTextDetection(args: StartTextDetectionCommandInput, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1192
243
|
startTextDetection(args: StartTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1193
|
-
|
|
1194
|
-
* <p>Stops a running model. The operation might take a while to complete. To
|
|
1195
|
-
* check the current status, call <a>DescribeProjectVersions</a>. </p>
|
|
1196
|
-
*/
|
|
244
|
+
|
|
1197
245
|
stopProjectVersion(args: StopProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<StopProjectVersionCommandOutput>;
|
|
1198
246
|
stopProjectVersion(args: StopProjectVersionCommandInput, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1199
247
|
stopProjectVersion(args: StopProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1200
|
-
|
|
1201
|
-
* <p>Stops a running stream processor that was created by <a>CreateStreamProcessor</a>.</p>
|
|
1202
|
-
*/
|
|
248
|
+
|
|
1203
249
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StopStreamProcessorCommandOutput>;
|
|
1204
250
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1205
251
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1206
|
-
|
|
1207
|
-
* <p>
|
|
1208
|
-
* Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a>.
|
|
1209
|
-
* </p>
|
|
1210
|
-
* <p>This operation requires permissions to perform the
|
|
1211
|
-
* <code>rekognition:TagResource</code> action. </p>
|
|
1212
|
-
*/
|
|
252
|
+
|
|
1213
253
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1214
254
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1215
255
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1216
|
-
|
|
1217
|
-
* <p>
|
|
1218
|
-
* Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
|
|
1219
|
-
* </p>
|
|
1220
|
-
* <p>This operation requires permissions to perform the
|
|
1221
|
-
* <code>rekognition:UntagResource</code> action. </p>
|
|
1222
|
-
*/
|
|
256
|
+
|
|
1223
257
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1224
258
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1225
259
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|