@aws-sdk/client-rekognition 3.288.0 → 3.290.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/dist-types/commands/CompareFacesCommand.d.ts +80 -0
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +61 -0
- package/dist-types/commands/CreateCollectionCommand.d.ts +43 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +32 -0
- package/dist-types/commands/CreateProjectCommand.d.ts +26 -0
- package/dist-types/commands/CreateProjectVersionCommand.d.ts +34 -0
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +31 -0
- package/dist-types/commands/DeleteCollectionCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +29 -0
- package/dist-types/commands/DeleteFacesCommand.d.ts +42 -0
- package/dist-types/commands/DeleteProjectCommand.d.ts +24 -0
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +37 -0
- package/dist-types/commands/DeleteProjectVersionCommand.d.ts +24 -0
- package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +24 -0
- package/dist-types/commands/DescribeCollectionCommand.d.ts +21 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +21 -0
- package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeProjectsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +21 -0
- package/dist-types/commands/DetectCustomLabelsCommand.d.ts +43 -0
- package/dist-types/commands/DetectFacesCommand.d.ts +98 -0
- package/dist-types/commands/DetectLabelsCommand.d.ts +62 -0
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +33 -0
- package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +30 -0
- package/dist-types/commands/DetectTextCommand.d.ts +30 -0
- package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +26 -0
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +21 -0
- package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +24 -0
- package/dist-types/commands/GetContentModerationCommand.d.ts +24 -0
- package/dist-types/commands/GetFaceDetectionCommand.d.ts +24 -0
- package/dist-types/commands/GetFaceSearchCommand.d.ts +24 -0
- package/dist-types/commands/GetLabelDetectionCommand.d.ts +24 -0
- package/dist-types/commands/GetPersonTrackingCommand.d.ts +24 -0
- package/dist-types/commands/GetSegmentDetectionCommand.d.ts +24 -0
- package/dist-types/commands/GetTextDetectionCommand.d.ts +24 -0
- package/dist-types/commands/IndexFacesCommand.d.ts +180 -0
- package/dist-types/commands/ListCollectionsCommand.d.ts +40 -0
- package/dist-types/commands/ListDatasetEntriesCommand.d.ts +32 -0
- package/dist-types/commands/ListDatasetLabelsCommand.d.ts +32 -0
- package/dist-types/commands/ListFacesCommand.d.ts +163 -0
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +52 -0
- package/dist-types/commands/ListStreamProcessorsCommand.d.ts +21 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +60 -0
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +30 -0
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +79 -0
- package/dist-types/commands/SearchFacesCommand.d.ts +84 -0
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +34 -0
- package/dist-types/commands/StartContentModerationCommand.d.ts +34 -0
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +34 -0
- package/dist-types/commands/StartFaceSearchCommand.d.ts +37 -0
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +34 -0
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +34 -0
- package/dist-types/commands/StartProjectVersionCommand.d.ts +29 -0
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +34 -0
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +24 -0
- package/dist-types/commands/StartTextDetectionCommand.d.ts +34 -0
- package/dist-types/commands/StopProjectVersionCommand.d.ts +24 -0
- package/dist-types/commands/StopStreamProcessorCommand.d.ts +24 -0
- package/dist-types/commands/TagResourceCommand.d.ts +26 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +21 -0
- package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +29 -0
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +21 -0
- package/package.json +30 -30
|
@@ -94,6 +94,30 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
|
|
|
94
94
|
* @see {@link GetLabelDetectionCommandOutput} for command's `response` shape.
|
|
95
95
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
96
96
|
*
|
|
97
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
98
|
+
* <p>You are not authorized to perform the action.</p>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InternalServerError} (server fault)
|
|
101
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
104
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
107
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
108
|
+
* operation again.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
111
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
112
|
+
* limit, contact Amazon Rekognition.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
115
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
118
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
119
|
+
*
|
|
120
|
+
*
|
|
97
121
|
*/
|
|
98
122
|
export declare class GetLabelDetectionCommand extends $Command<GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
99
123
|
readonly input: GetLabelDetectionCommandInput;
|
|
@@ -53,6 +53,30 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons
|
|
|
53
53
|
* @see {@link GetPersonTrackingCommandOutput} for command's `response` shape.
|
|
54
54
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
55
55
|
*
|
|
56
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
+
* <p>You are not authorized to perform the action.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerError} (server fault)
|
|
60
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
63
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
66
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
67
|
+
* operation again.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
70
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
71
|
+
* limit, contact Amazon Rekognition.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
77
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
56
80
|
*/
|
|
57
81
|
export declare class GetPersonTrackingCommand extends $Command<GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput, RekognitionClientResolvedConfig> {
|
|
58
82
|
readonly input: GetPersonTrackingCommandInput;
|
|
@@ -50,6 +50,30 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes
|
|
|
50
50
|
* @see {@link GetSegmentDetectionCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>You are not authorized to perform the action.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InternalServerError} (server fault)
|
|
57
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
60
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
63
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
64
|
+
* operation again.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
67
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
68
|
+
* limit, contact Amazon Rekognition.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
71
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
74
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
53
77
|
*/
|
|
54
78
|
export declare class GetSegmentDetectionCommand extends $Command<GetSegmentDetectionCommandInput, GetSegmentDetectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
55
79
|
readonly input: GetSegmentDetectionCommandInput;
|
|
@@ -47,6 +47,30 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
|
|
|
47
47
|
* @see {@link GetTextDetectionCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
51
|
+
* <p>You are not authorized to perform the action.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link InternalServerError} (server fault)
|
|
54
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
57
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
60
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
61
|
+
* operation again.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
64
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
65
|
+
* limit, contact Amazon Rekognition.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
71
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
50
74
|
*/
|
|
51
75
|
export declare class GetTextDetectionCommand extends $Command<GetTextDetectionCommandInput, GetTextDetectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
52
76
|
readonly input: GetTextDetectionCommandInput;
|
|
@@ -119,6 +119,186 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
119
119
|
* @see {@link IndexFacesCommandOutput} for command's `response` shape.
|
|
120
120
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
121
121
|
*
|
|
122
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
123
|
+
* <p>You are not authorized to perform the action.</p>
|
|
124
|
+
*
|
|
125
|
+
* @throws {@link ImageTooLargeException} (client fault)
|
|
126
|
+
* <p>The input image size exceeds the allowed limit. If you are calling
|
|
127
|
+
* DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more
|
|
128
|
+
* information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
|
|
129
|
+
* </p>
|
|
130
|
+
*
|
|
131
|
+
* @throws {@link InternalServerError} (server fault)
|
|
132
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link InvalidImageFormatException} (client fault)
|
|
135
|
+
* <p>The provided image format is not supported. </p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
138
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
139
|
+
* operation again.</p>
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link InvalidS3ObjectException} (client fault)
|
|
142
|
+
* <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
145
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
146
|
+
* limit, contact Amazon Rekognition.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
149
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
152
|
+
* <p></p>
|
|
153
|
+
* <p>The size of the collection exceeds the allowed limit. For more information,
|
|
154
|
+
* see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
157
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
158
|
+
*
|
|
159
|
+
*
|
|
160
|
+
* @example To add a face to a collection
|
|
161
|
+
* ```javascript
|
|
162
|
+
* // This operation detects faces in an image and adds them to the specified Rekognition collection.
|
|
163
|
+
* const input = {
|
|
164
|
+
* "CollectionId": "myphotos",
|
|
165
|
+
* "DetectionAttributes": [],
|
|
166
|
+
* "ExternalImageId": "myphotoid",
|
|
167
|
+
* "Image": {
|
|
168
|
+
* "S3Object": {
|
|
169
|
+
* "Bucket": "mybucket",
|
|
170
|
+
* "Name": "myphoto"
|
|
171
|
+
* }
|
|
172
|
+
* }
|
|
173
|
+
* };
|
|
174
|
+
* const command = new IndexFacesCommand(input);
|
|
175
|
+
* const response = await client.send(command);
|
|
176
|
+
* /* response ==
|
|
177
|
+
* {
|
|
178
|
+
* "FaceRecords": [
|
|
179
|
+
* {
|
|
180
|
+
* "Face": {
|
|
181
|
+
* "BoundingBox": {
|
|
182
|
+
* "Height": 0.33481481671333313,
|
|
183
|
+
* "Left": 0.31888890266418457,
|
|
184
|
+
* "Top": 0.4933333396911621,
|
|
185
|
+
* "Width": 0.25
|
|
186
|
+
* },
|
|
187
|
+
* "Confidence": 99.9991226196289,
|
|
188
|
+
* "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
|
|
189
|
+
* "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
|
|
190
|
+
* },
|
|
191
|
+
* "FaceDetail": {
|
|
192
|
+
* "BoundingBox": {
|
|
193
|
+
* "Height": 0.33481481671333313,
|
|
194
|
+
* "Left": 0.31888890266418457,
|
|
195
|
+
* "Top": 0.4933333396911621,
|
|
196
|
+
* "Width": 0.25
|
|
197
|
+
* },
|
|
198
|
+
* "Confidence": 99.9991226196289,
|
|
199
|
+
* "Landmarks": [
|
|
200
|
+
* {
|
|
201
|
+
* "Type": "eyeLeft",
|
|
202
|
+
* "X": 0.3976764678955078,
|
|
203
|
+
* "Y": 0.6248345971107483
|
|
204
|
+
* },
|
|
205
|
+
* {
|
|
206
|
+
* "Type": "eyeRight",
|
|
207
|
+
* "X": 0.4810936450958252,
|
|
208
|
+
* "Y": 0.6317117214202881
|
|
209
|
+
* },
|
|
210
|
+
* {
|
|
211
|
+
* "Type": "noseLeft",
|
|
212
|
+
* "X": 0.41986238956451416,
|
|
213
|
+
* "Y": 0.7111940383911133
|
|
214
|
+
* },
|
|
215
|
+
* {
|
|
216
|
+
* "Type": "mouthDown",
|
|
217
|
+
* "X": 0.40525302290916443,
|
|
218
|
+
* "Y": 0.7497701048851013
|
|
219
|
+
* },
|
|
220
|
+
* {
|
|
221
|
+
* "Type": "mouthUp",
|
|
222
|
+
* "X": 0.4753248989582062,
|
|
223
|
+
* "Y": 0.7558549642562866
|
|
224
|
+
* }
|
|
225
|
+
* ],
|
|
226
|
+
* "Pose": {
|
|
227
|
+
* "Pitch": -9.713645935058594,
|
|
228
|
+
* "Roll": 4.707281112670898,
|
|
229
|
+
* "Yaw": -24.438663482666016
|
|
230
|
+
* },
|
|
231
|
+
* "Quality": {
|
|
232
|
+
* "Brightness": 29.23358917236328,
|
|
233
|
+
* "Sharpness": 80
|
|
234
|
+
* }
|
|
235
|
+
* }
|
|
236
|
+
* },
|
|
237
|
+
* {
|
|
238
|
+
* "Face": {
|
|
239
|
+
* "BoundingBox": {
|
|
240
|
+
* "Height": 0.32592591643333435,
|
|
241
|
+
* "Left": 0.5144444704055786,
|
|
242
|
+
* "Top": 0.15111111104488373,
|
|
243
|
+
* "Width": 0.24444444477558136
|
|
244
|
+
* },
|
|
245
|
+
* "Confidence": 99.99950408935547,
|
|
246
|
+
* "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
|
|
247
|
+
* "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
|
|
248
|
+
* },
|
|
249
|
+
* "FaceDetail": {
|
|
250
|
+
* "BoundingBox": {
|
|
251
|
+
* "Height": 0.32592591643333435,
|
|
252
|
+
* "Left": 0.5144444704055786,
|
|
253
|
+
* "Top": 0.15111111104488373,
|
|
254
|
+
* "Width": 0.24444444477558136
|
|
255
|
+
* },
|
|
256
|
+
* "Confidence": 99.99950408935547,
|
|
257
|
+
* "Landmarks": [
|
|
258
|
+
* {
|
|
259
|
+
* "Type": "eyeLeft",
|
|
260
|
+
* "X": 0.6006892323493958,
|
|
261
|
+
* "Y": 0.290842205286026
|
|
262
|
+
* },
|
|
263
|
+
* {
|
|
264
|
+
* "Type": "eyeRight",
|
|
265
|
+
* "X": 0.6808141469955444,
|
|
266
|
+
* "Y": 0.29609042406082153
|
|
267
|
+
* },
|
|
268
|
+
* {
|
|
269
|
+
* "Type": "noseLeft",
|
|
270
|
+
* "X": 0.6395332217216492,
|
|
271
|
+
* "Y": 0.3522595763206482
|
|
272
|
+
* },
|
|
273
|
+
* {
|
|
274
|
+
* "Type": "mouthDown",
|
|
275
|
+
* "X": 0.5892083048820496,
|
|
276
|
+
* "Y": 0.38689887523651123
|
|
277
|
+
* },
|
|
278
|
+
* {
|
|
279
|
+
* "Type": "mouthUp",
|
|
280
|
+
* "X": 0.674560010433197,
|
|
281
|
+
* "Y": 0.394125759601593
|
|
282
|
+
* }
|
|
283
|
+
* ],
|
|
284
|
+
* "Pose": {
|
|
285
|
+
* "Pitch": -4.683138370513916,
|
|
286
|
+
* "Roll": 2.1029529571533203,
|
|
287
|
+
* "Yaw": 6.716655254364014
|
|
288
|
+
* },
|
|
289
|
+
* "Quality": {
|
|
290
|
+
* "Brightness": 34.951698303222656,
|
|
291
|
+
* "Sharpness": 160
|
|
292
|
+
* }
|
|
293
|
+
* }
|
|
294
|
+
* }
|
|
295
|
+
* ],
|
|
296
|
+
* "OrientationCorrection": "ROTATE_0"
|
|
297
|
+
* }
|
|
298
|
+
* *\/
|
|
299
|
+
* // example id: to-add-a-face-to-a-collection-1482179542923
|
|
300
|
+
* ```
|
|
301
|
+
*
|
|
122
302
|
*/
|
|
123
303
|
export declare class IndexFacesCommand extends $Command<IndexFacesCommandInput, IndexFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
124
304
|
readonly input: IndexFacesCommandInput;
|
|
@@ -35,6 +35,46 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
|
|
|
35
35
|
* @see {@link ListCollectionsCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
39
|
+
* <p>You are not authorized to perform the action.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InternalServerError} (server fault)
|
|
42
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
45
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
48
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
49
|
+
* operation again.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
52
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
53
|
+
* limit, contact Amazon Rekognition.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
56
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
59
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
60
|
+
*
|
|
61
|
+
*
|
|
62
|
+
* @example To list the collections
|
|
63
|
+
* ```javascript
|
|
64
|
+
* // This operation returns a list of Rekognition collections.
|
|
65
|
+
* const input = {};
|
|
66
|
+
* const command = new ListCollectionsCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "CollectionIds": [
|
|
71
|
+
* "myphotos"
|
|
72
|
+
* ]
|
|
73
|
+
* }
|
|
74
|
+
* *\/
|
|
75
|
+
* // example id: to-list-the-collections-1482179199088
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
38
78
|
*/
|
|
39
79
|
export declare class ListCollectionsCommand extends $Command<ListCollectionsCommandInput, ListCollectionsCommandOutput, RekognitionClientResolvedConfig> {
|
|
40
80
|
readonly input: ListCollectionsCommandInput;
|
|
@@ -42,6 +42,38 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
|
|
|
42
42
|
* @see {@link ListDatasetEntriesCommandOutput} for command's `response` shape.
|
|
43
43
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
44
44
|
*
|
|
45
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
46
|
+
* <p>You are not authorized to perform the action.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link InternalServerError} (server fault)
|
|
49
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
52
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
55
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
56
|
+
* operation again.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
59
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
60
|
+
* limit, contact Amazon Rekognition.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
63
|
+
* <p>The specified resource is already being used.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ResourceNotReadyException} (client fault)
|
|
69
|
+
* <p>The requested resource isn't ready. For example,
|
|
70
|
+
* this exception occurs when you call <code>DetectCustomLabels</code> with a
|
|
71
|
+
* model version that isn't deployed. </p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
74
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
45
77
|
*/
|
|
46
78
|
export declare class ListDatasetEntriesCommand extends $Command<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
|
|
47
79
|
readonly input: ListDatasetEntriesCommandInput;
|
|
@@ -34,6 +34,38 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
|
|
|
34
34
|
* @see {@link ListDatasetLabelsCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
38
|
+
* <p>You are not authorized to perform the action.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InternalServerError} (server fault)
|
|
41
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
44
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
47
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
48
|
+
* operation again.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
51
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
52
|
+
* limit, contact Amazon Rekognition.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ResourceInUseException} (client fault)
|
|
55
|
+
* <p>The specified resource is already being used.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
58
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ResourceNotReadyException} (client fault)
|
|
61
|
+
* <p>The requested resource isn't ready. For example,
|
|
62
|
+
* this exception occurs when you call <code>DetectCustomLabels</code> with a
|
|
63
|
+
* model version that isn't deployed. </p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
66
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
37
69
|
*/
|
|
38
70
|
export declare class ListDatasetLabelsCommand extends $Command<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput, RekognitionClientResolvedConfig> {
|
|
39
71
|
readonly input: ListDatasetLabelsCommandInput;
|
|
@@ -34,6 +34,169 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
|
|
|
34
34
|
* @see {@link ListFacesCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
38
|
+
* <p>You are not authorized to perform the action.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InternalServerError} (server fault)
|
|
41
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
44
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
47
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
48
|
+
* operation again.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
51
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
52
|
+
* limit, contact Amazon Rekognition.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
55
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
58
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
59
|
+
*
|
|
60
|
+
*
|
|
61
|
+
* @example To list the faces in a collection
|
|
62
|
+
* ```javascript
|
|
63
|
+
* // This operation lists the faces in a Rekognition collection.
|
|
64
|
+
* const input = {
|
|
65
|
+
* "CollectionId": "myphotos",
|
|
66
|
+
* "MaxResults": 20
|
|
67
|
+
* };
|
|
68
|
+
* const command = new ListFacesCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* /* response ==
|
|
71
|
+
* {
|
|
72
|
+
* "Faces": [
|
|
73
|
+
* {
|
|
74
|
+
* "BoundingBox": {
|
|
75
|
+
* "Height": 0.18000000715255737,
|
|
76
|
+
* "Left": 0.5555559992790222,
|
|
77
|
+
* "Top": 0.336667001247406,
|
|
78
|
+
* "Width": 0.23999999463558197
|
|
79
|
+
* },
|
|
80
|
+
* "Confidence": 100,
|
|
81
|
+
* "FaceId": "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7",
|
|
82
|
+
* "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
|
|
83
|
+
* },
|
|
84
|
+
* {
|
|
85
|
+
* "BoundingBox": {
|
|
86
|
+
* "Height": 0.16555599868297577,
|
|
87
|
+
* "Left": 0.30963000655174255,
|
|
88
|
+
* "Top": 0.7066670060157776,
|
|
89
|
+
* "Width": 0.22074100375175476
|
|
90
|
+
* },
|
|
91
|
+
* "Confidence": 100,
|
|
92
|
+
* "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c",
|
|
93
|
+
* "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
|
|
94
|
+
* },
|
|
95
|
+
* {
|
|
96
|
+
* "BoundingBox": {
|
|
97
|
+
* "Height": 0.3234420120716095,
|
|
98
|
+
* "Left": 0.3233329951763153,
|
|
99
|
+
* "Top": 0.5,
|
|
100
|
+
* "Width": 0.24222199618816376
|
|
101
|
+
* },
|
|
102
|
+
* "Confidence": 99.99829864501953,
|
|
103
|
+
* "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85",
|
|
104
|
+
* "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
|
|
105
|
+
* },
|
|
106
|
+
* {
|
|
107
|
+
* "BoundingBox": {
|
|
108
|
+
* "Height": 0.03555560111999512,
|
|
109
|
+
* "Left": 0.37388700246810913,
|
|
110
|
+
* "Top": 0.2477779984474182,
|
|
111
|
+
* "Width": 0.04747769981622696
|
|
112
|
+
* },
|
|
113
|
+
* "Confidence": 99.99210357666016,
|
|
114
|
+
* "FaceId": "3b01bef0-c883-5654-ba42-d5ad28b720b3",
|
|
115
|
+
* "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
|
|
116
|
+
* },
|
|
117
|
+
* {
|
|
118
|
+
* "BoundingBox": {
|
|
119
|
+
* "Height": 0.05333330109715462,
|
|
120
|
+
* "Left": 0.2937690019607544,
|
|
121
|
+
* "Top": 0.35666701197624207,
|
|
122
|
+
* "Width": 0.07121659815311432
|
|
123
|
+
* },
|
|
124
|
+
* "Confidence": 99.99919891357422,
|
|
125
|
+
* "FaceId": "4839a608-49d0-566c-8301-509d71b534d1",
|
|
126
|
+
* "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
|
|
127
|
+
* },
|
|
128
|
+
* {
|
|
129
|
+
* "BoundingBox": {
|
|
130
|
+
* "Height": 0.3249259889125824,
|
|
131
|
+
* "Left": 0.5155559778213501,
|
|
132
|
+
* "Top": 0.1513350009918213,
|
|
133
|
+
* "Width": 0.24333299696445465
|
|
134
|
+
* },
|
|
135
|
+
* "Confidence": 99.99949645996094,
|
|
136
|
+
* "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14",
|
|
137
|
+
* "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
|
|
138
|
+
* },
|
|
139
|
+
* {
|
|
140
|
+
* "BoundingBox": {
|
|
141
|
+
* "Height": 0.03777780011296272,
|
|
142
|
+
* "Left": 0.7002969980239868,
|
|
143
|
+
* "Top": 0.18777799606323242,
|
|
144
|
+
* "Width": 0.05044509842991829
|
|
145
|
+
* },
|
|
146
|
+
* "Confidence": 99.92639923095703,
|
|
147
|
+
* "FaceId": "7f5f88ed-d684-5a88-b0df-01e4a521552b",
|
|
148
|
+
* "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
|
|
149
|
+
* },
|
|
150
|
+
* {
|
|
151
|
+
* "BoundingBox": {
|
|
152
|
+
* "Height": 0.05555560067296028,
|
|
153
|
+
* "Left": 0.13946600258350372,
|
|
154
|
+
* "Top": 0.46333301067352295,
|
|
155
|
+
* "Width": 0.07270029932260513
|
|
156
|
+
* },
|
|
157
|
+
* "Confidence": 99.99469757080078,
|
|
158
|
+
* "FaceId": "895b4e2c-81de-5902-a4bd-d1792bda00b2",
|
|
159
|
+
* "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
|
|
160
|
+
* },
|
|
161
|
+
* {
|
|
162
|
+
* "BoundingBox": {
|
|
163
|
+
* "Height": 0.3259260058403015,
|
|
164
|
+
* "Left": 0.5144439935684204,
|
|
165
|
+
* "Top": 0.15111100673675537,
|
|
166
|
+
* "Width": 0.24444399774074554
|
|
167
|
+
* },
|
|
168
|
+
* "Confidence": 99.99949645996094,
|
|
169
|
+
* "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
|
|
170
|
+
* "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
|
|
171
|
+
* },
|
|
172
|
+
* {
|
|
173
|
+
* "BoundingBox": {
|
|
174
|
+
* "Height": 0.18888899683952332,
|
|
175
|
+
* "Left": 0.3783380091190338,
|
|
176
|
+
* "Top": 0.2355560064315796,
|
|
177
|
+
* "Width": 0.25222599506378174
|
|
178
|
+
* },
|
|
179
|
+
* "Confidence": 99.9999008178711,
|
|
180
|
+
* "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5",
|
|
181
|
+
* "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07"
|
|
182
|
+
* },
|
|
183
|
+
* {
|
|
184
|
+
* "BoundingBox": {
|
|
185
|
+
* "Height": 0.33481499552726746,
|
|
186
|
+
* "Left": 0.31888899207115173,
|
|
187
|
+
* "Top": 0.49333301186561584,
|
|
188
|
+
* "Width": 0.25
|
|
189
|
+
* },
|
|
190
|
+
* "Confidence": 99.99909973144531,
|
|
191
|
+
* "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
|
|
192
|
+
* "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
|
|
193
|
+
* }
|
|
194
|
+
* ]
|
|
195
|
+
* }
|
|
196
|
+
* *\/
|
|
197
|
+
* // example id: to-list-the-faces-in-a-collection-1482181416530
|
|
198
|
+
* ```
|
|
199
|
+
*
|
|
37
200
|
*/
|
|
38
201
|
export declare class ListFacesCommand extends $Command<ListFacesCommandInput, ListFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
39
202
|
readonly input: ListFacesCommandInput;
|
|
@@ -30,6 +30,58 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
|
|
|
30
30
|
* @see {@link ListProjectPoliciesCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
34
|
+
* <p>You are not authorized to perform the action.</p>
|
|
35
|
+
*
|
|
36
|
+
* @throws {@link InternalServerError} (server fault)
|
|
37
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidPaginationTokenException} (client fault)
|
|
40
|
+
* <p>Pagination token in the request is not valid.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
43
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
44
|
+
* operation again.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ProvisionedThroughputExceededException} (client fault)
|
|
47
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
48
|
+
* limit, contact Amazon Rekognition.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
51
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ThrottlingException} (server fault)
|
|
54
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
57
|
+
* @example ListProjectPolicies
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // This operation lists the project policies that are attached to an Amazon Rekognition Custom Labels project.
|
|
60
|
+
* const input = {
|
|
61
|
+
* "MaxResults": 5,
|
|
62
|
+
* "NextToken": "",
|
|
63
|
+
* "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
|
|
64
|
+
* };
|
|
65
|
+
* const command = new ListProjectPoliciesCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* /* response ==
|
|
68
|
+
* {
|
|
69
|
+
* "NextToken": "",
|
|
70
|
+
* "ProjectPolicies": [
|
|
71
|
+
* {
|
|
72
|
+
* "CreationTimestamp": "2022-07-01T11:51:27.086000-07:00",
|
|
73
|
+
* "LastUpdatedTimestamp": "2022-07-01T11:51:27.086000-07:00",
|
|
74
|
+
* "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Statemented1\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"*\"}]}",
|
|
75
|
+
* "PolicyName": "testPolicy",
|
|
76
|
+
* "PolicyRevisionId": "3b274c25e9203a56a99e00e3ff205fbc",
|
|
77
|
+
* "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
|
|
78
|
+
* }
|
|
79
|
+
* ]
|
|
80
|
+
* }
|
|
81
|
+
* *\/
|
|
82
|
+
* // example id: listprojectpolicies-1658202290173
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
33
85
|
*/
|
|
34
86
|
export declare class ListProjectPoliciesCommand extends $Command<ListProjectPoliciesCommandInput, ListProjectPoliciesCommandOutput, RekognitionClientResolvedConfig> {
|
|
35
87
|
readonly input: ListProjectPoliciesCommandInput;
|