@aws-sdk/client-rekognition 3.775.0 → 3.777.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/AssociateFacesCommand.d.ts +18 -18
- package/dist-types/commands/CompareFacesCommand.d.ts +28 -28
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +14 -14
- package/dist-types/commands/CreateCollectionCommand.d.ts +6 -6
- package/dist-types/commands/CreateDatasetCommand.d.ts +11 -11
- package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +1 -0
- package/dist-types/commands/CreateProjectCommand.d.ts +5 -5
- package/dist-types/commands/CreateProjectVersionCommand.d.ts +9 -9
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/CreateUserCommand.d.ts +8 -5
- package/dist-types/commands/DeleteCollectionCommand.d.ts +5 -5
- package/dist-types/commands/DeleteDatasetCommand.d.ts +7 -4
- package/dist-types/commands/DeleteFacesCommand.d.ts +6 -6
- package/dist-types/commands/DeleteProjectCommand.d.ts +5 -5
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +9 -6
- package/dist-types/commands/DeleteProjectVersionCommand.d.ts +5 -5
- package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +9 -6
- package/dist-types/commands/DescribeCollectionCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -28
- package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +1 -105
- package/dist-types/commands/DescribeProjectsCommand.d.ts +1 -42
- package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/DetectCustomLabelsCommand.d.ts +15 -15
- package/dist-types/commands/DetectFacesCommand.d.ts +38 -38
- package/dist-types/commands/DetectLabelsCommand.d.ts +14 -14
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +1 -0
- package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +1 -0
- package/dist-types/commands/DetectTextCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateFacesCommand.d.ts +14 -14
- package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +9 -6
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +1 -0
- package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +1 -0
- package/dist-types/commands/GetContentModerationCommand.d.ts +1 -0
- package/dist-types/commands/GetFaceDetectionCommand.d.ts +1 -0
- package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +1 -0
- package/dist-types/commands/GetFaceSearchCommand.d.ts +1 -0
- package/dist-types/commands/GetLabelDetectionCommand.d.ts +1 -0
- package/dist-types/commands/GetMediaAnalysisJobCommand.d.ts +1 -48
- package/dist-types/commands/GetPersonTrackingCommand.d.ts +1 -0
- package/dist-types/commands/GetSegmentDetectionCommand.d.ts +1 -0
- package/dist-types/commands/GetTextDetectionCommand.d.ts +1 -0
- package/dist-types/commands/IndexFacesCommand.d.ts +90 -90
- package/dist-types/commands/ListCollectionsCommand.d.ts +5 -5
- package/dist-types/commands/ListDatasetEntriesCommand.d.ts +13 -13
- package/dist-types/commands/ListDatasetLabelsCommand.d.ts +16 -16
- package/dist-types/commands/ListFacesCommand.d.ts +35 -35
- package/dist-types/commands/ListMediaAnalysisJobsCommand.d.ts +1 -52
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +1 -28
- package/dist-types/commands/ListStreamProcessorsCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -0
- package/dist-types/commands/ListUsersCommand.d.ts +10 -10
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +8 -8
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +1 -0
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +27 -27
- package/dist-types/commands/SearchFacesCommand.d.ts +39 -39
- package/dist-types/commands/SearchUsersByImageCommand.d.ts +39 -39
- package/dist-types/commands/SearchUsersCommand.d.ts +15 -15
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +1 -0
- package/dist-types/commands/StartContentModerationCommand.d.ts +1 -0
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +1 -0
- package/dist-types/commands/StartFaceSearchCommand.d.ts +1 -0
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +1 -0
- package/dist-types/commands/StartMediaAnalysisJobCommand.d.ts +16 -16
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +1 -0
- package/dist-types/commands/StartProjectVersionCommand.d.ts +7 -7
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -0
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/StartTextDetectionCommand.d.ts +1 -0
- package/dist-types/commands/StopProjectVersionCommand.d.ts +5 -5
- package/dist-types/commands/StopStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -0
- package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +9 -6
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +1 -0
- package/package.json +2 -2
|
@@ -138,52 +138,52 @@ declare const AssociateFacesCommand_base: {
|
|
|
138
138
|
* @throws {@link RekognitionServiceException}
|
|
139
139
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
140
140
|
*
|
|
141
|
-
*
|
|
141
|
+
*
|
|
142
142
|
* @example AssociateFaces
|
|
143
143
|
* ```javascript
|
|
144
144
|
* // This operation associates one or more faces with an existing UserID.
|
|
145
145
|
* const input = {
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
146
|
+
* ClientRequestToken: "550e8400-e29b-41d4-a716-446655440002",
|
|
147
|
+
* CollectionId: "MyCollection",
|
|
148
|
+
* FaceIds: [
|
|
149
149
|
* "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
150
150
|
* "851cb847-dccc-4fea-9309-9f4805967855",
|
|
151
151
|
* "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
|
|
152
152
|
* ],
|
|
153
|
-
*
|
|
154
|
-
*
|
|
153
|
+
* UserId: "DemoUser",
|
|
154
|
+
* UserMatchThreshold: 70
|
|
155
155
|
* };
|
|
156
156
|
* const command = new AssociateFacesCommand(input);
|
|
157
157
|
* const response = await client.send(command);
|
|
158
|
-
* /* response
|
|
158
|
+
* /* response is
|
|
159
159
|
* {
|
|
160
|
-
*
|
|
160
|
+
* AssociatedFaces: [
|
|
161
161
|
* {
|
|
162
|
-
*
|
|
162
|
+
* FaceId: "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
|
|
163
163
|
* }
|
|
164
164
|
* ],
|
|
165
|
-
*
|
|
165
|
+
* UnsuccessfulFaceAssociations: [
|
|
166
166
|
* {
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
167
|
+
* Confidence: 0.9375374913215637,
|
|
168
|
+
* FaceId: "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
169
|
+
* Reasons: [
|
|
170
170
|
* "LOW_MATCH_CONFIDENCE"
|
|
171
171
|
* ]
|
|
172
172
|
* },
|
|
173
173
|
* {
|
|
174
|
-
*
|
|
175
|
-
*
|
|
174
|
+
* FaceId: "851cb847-dccc-4fea-9309-9f4805967855",
|
|
175
|
+
* Reasons: [
|
|
176
176
|
* "ASSOCIATED_TO_A_DIFFERENT_USER"
|
|
177
177
|
* ],
|
|
178
|
-
*
|
|
178
|
+
* UserId: "demoUser2"
|
|
179
179
|
* }
|
|
180
180
|
* ],
|
|
181
|
-
*
|
|
181
|
+
* UserStatus: "UPDATING"
|
|
182
182
|
* }
|
|
183
183
|
* *\/
|
|
184
|
-
* // example id: associatefaces-1686181269281
|
|
185
184
|
* ```
|
|
186
185
|
*
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
export declare class AssociateFacesCommand extends AssociateFacesCommand_base {
|
|
189
189
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -232,57 +232,57 @@ declare const CompareFacesCommand_base: {
|
|
|
232
232
|
* @throws {@link RekognitionServiceException}
|
|
233
233
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
234
234
|
*
|
|
235
|
-
*
|
|
235
|
+
*
|
|
236
236
|
* @example To compare two images
|
|
237
237
|
* ```javascript
|
|
238
238
|
* // This operation compares the largest face detected in the source image with each face detected in the target image.
|
|
239
239
|
* const input = {
|
|
240
|
-
*
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
240
|
+
* SimilarityThreshold: 90,
|
|
241
|
+
* SourceImage: {
|
|
242
|
+
* S3Object: {
|
|
243
|
+
* Bucket: "mybucket",
|
|
244
|
+
* Name: "mysourceimage"
|
|
245
245
|
* }
|
|
246
246
|
* },
|
|
247
|
-
*
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
*
|
|
247
|
+
* TargetImage: {
|
|
248
|
+
* S3Object: {
|
|
249
|
+
* Bucket: "mybucket",
|
|
250
|
+
* Name: "mytargetimage"
|
|
251
251
|
* }
|
|
252
252
|
* }
|
|
253
253
|
* };
|
|
254
254
|
* const command = new CompareFacesCommand(input);
|
|
255
255
|
* const response = await client.send(command);
|
|
256
|
-
* /* response
|
|
256
|
+
* /* response is
|
|
257
257
|
* {
|
|
258
|
-
*
|
|
258
|
+
* FaceMatches: [
|
|
259
259
|
* {
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
260
|
+
* Face: {
|
|
261
|
+
* BoundingBox: {
|
|
262
|
+
* Height: 0.33481481671333313,
|
|
263
|
+
* Left: 0.31888890266418457,
|
|
264
|
+
* Top: 0.4933333396911621,
|
|
265
|
+
* Width: 0.25
|
|
266
266
|
* },
|
|
267
|
-
*
|
|
267
|
+
* Confidence: 99.9991226196289
|
|
268
268
|
* },
|
|
269
|
-
*
|
|
269
|
+
* Similarity: 100
|
|
270
270
|
* }
|
|
271
271
|
* ],
|
|
272
|
-
*
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
272
|
+
* SourceImageFace: {
|
|
273
|
+
* BoundingBox: {
|
|
274
|
+
* Height: 0.33481481671333313,
|
|
275
|
+
* Left: 0.31888890266418457,
|
|
276
|
+
* Top: 0.4933333396911621,
|
|
277
|
+
* Width: 0.25
|
|
278
278
|
* },
|
|
279
|
-
*
|
|
279
|
+
* Confidence: 99.9991226196289
|
|
280
280
|
* }
|
|
281
281
|
* }
|
|
282
282
|
* *\/
|
|
283
|
-
* // example id: to-compare-two-images-1482181985581
|
|
284
283
|
* ```
|
|
285
284
|
*
|
|
285
|
+
* @public
|
|
286
286
|
*/
|
|
287
287
|
export declare class CompareFacesCommand extends CompareFacesCommand_base {
|
|
288
288
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -124,34 +124,34 @@ declare const CopyProjectVersionCommand_base: {
|
|
|
124
124
|
* @throws {@link RekognitionServiceException}
|
|
125
125
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
126
126
|
*
|
|
127
|
-
*
|
|
127
|
+
*
|
|
128
128
|
* @example CopyProjectVersion
|
|
129
129
|
* ```javascript
|
|
130
130
|
* // Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
|
|
131
131
|
* const input = {
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
132
|
+
* DestinationProjectArn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765",
|
|
133
|
+
* KmsKeyId: "arn:1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
134
|
+
* OutputConfig: {
|
|
135
|
+
* S3Bucket: "bucket-name",
|
|
136
|
+
* S3KeyPrefix: "path_to_folder"
|
|
137
137
|
* },
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
138
|
+
* SourceProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456",
|
|
139
|
+
* SourceProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456",
|
|
140
|
+
* Tags: {
|
|
141
|
+
* key1: "val1"
|
|
142
142
|
* },
|
|
143
|
-
*
|
|
143
|
+
* VersionName: "DestinationVersionName_cross_account"
|
|
144
144
|
* };
|
|
145
145
|
* const command = new CopyProjectVersionCommand(input);
|
|
146
146
|
* const response = await client.send(command);
|
|
147
|
-
* /* response
|
|
147
|
+
* /* response is
|
|
148
148
|
* {
|
|
149
|
-
*
|
|
149
|
+
* ProjectVersionArn: "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651"
|
|
150
150
|
* }
|
|
151
151
|
* *\/
|
|
152
|
-
* // example id: copyprojectversion-1658203943815
|
|
153
152
|
* ```
|
|
154
153
|
*
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
export declare class CopyProjectVersionCommand extends CopyProjectVersionCommand_base {
|
|
157
157
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -98,24 +98,24 @@ declare const CreateCollectionCommand_base: {
|
|
|
98
98
|
* @throws {@link RekognitionServiceException}
|
|
99
99
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
100
100
|
*
|
|
101
|
-
*
|
|
101
|
+
*
|
|
102
102
|
* @example To create a collection
|
|
103
103
|
* ```javascript
|
|
104
104
|
* // This operation creates a Rekognition collection for storing image data.
|
|
105
105
|
* const input = {
|
|
106
|
-
*
|
|
106
|
+
* CollectionId: "myphotos"
|
|
107
107
|
* };
|
|
108
108
|
* const command = new CreateCollectionCommand(input);
|
|
109
109
|
* const response = await client.send(command);
|
|
110
|
-
* /* response
|
|
110
|
+
* /* response is
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* CollectionArn: "aws:rekognition:us-west-2:123456789012:collection/myphotos",
|
|
113
|
+
* StatusCode: 200
|
|
114
114
|
* }
|
|
115
115
|
* *\/
|
|
116
|
-
* // example id: to-create-a-collection-1481833313674
|
|
117
116
|
* ```
|
|
118
117
|
*
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
export declare class CreateCollectionCommand extends CreateCollectionCommand_base {
|
|
121
121
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -122,32 +122,32 @@ declare const CreateDatasetCommand_base: {
|
|
|
122
122
|
* @throws {@link RekognitionServiceException}
|
|
123
123
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
124
124
|
*
|
|
125
|
-
*
|
|
125
|
+
*
|
|
126
126
|
* @example To create an Amazon Rekognition Custom Labels dataset
|
|
127
127
|
* ```javascript
|
|
128
128
|
* // Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.
|
|
129
129
|
* const input = {
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
130
|
+
* DatasetSource: {
|
|
131
|
+
* GroundTruthManifest: {
|
|
132
|
+
* S3Object: {
|
|
133
|
+
* Bucket: "my-bucket",
|
|
134
|
+
* Name: "datasets/flowers_training/manifests/output/output.manifest"
|
|
135
135
|
* }
|
|
136
136
|
* }
|
|
137
137
|
* },
|
|
138
|
-
*
|
|
139
|
-
*
|
|
138
|
+
* DatasetType: "TRAIN",
|
|
139
|
+
* ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815"
|
|
140
140
|
* };
|
|
141
141
|
* const command = new CreateDatasetCommand(input);
|
|
142
142
|
* const response = await client.send(command);
|
|
143
|
-
* /* response
|
|
143
|
+
* /* response is
|
|
144
144
|
* {
|
|
145
|
-
*
|
|
145
|
+
* DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535"
|
|
146
146
|
* }
|
|
147
147
|
* *\/
|
|
148
|
-
* // example id: to-create-an-amazon-rekognition-custom-labels-dataset-1690476237145
|
|
149
148
|
* ```
|
|
150
149
|
*
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
export declare class CreateDatasetCommand extends CreateDatasetCommand_base {
|
|
153
153
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,6 +88,7 @@ declare const CreateFaceLivenessSessionCommand_base: {
|
|
|
88
88
|
* @throws {@link RekognitionServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
90
90
|
*
|
|
91
|
+
*
|
|
91
92
|
* @public
|
|
92
93
|
*/
|
|
93
94
|
export declare class CreateFaceLivenessSessionCommand extends CreateFaceLivenessSessionCommand_base {
|
|
@@ -91,23 +91,23 @@ declare const CreateProjectCommand_base: {
|
|
|
91
91
|
* @throws {@link RekognitionServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To create an Amazon Rekognition Custom Labels project
|
|
96
96
|
* ```javascript
|
|
97
97
|
* // Creates an Amazon Rekognition Custom Labels project.
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
99
|
+
* ProjectName: "my-project"
|
|
100
100
|
* };
|
|
101
101
|
* const command = new CreateProjectCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
104
104
|
* {
|
|
105
|
-
*
|
|
105
|
+
* ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
|
|
106
106
|
* }
|
|
107
107
|
* *\/
|
|
108
|
-
* // example id: to-create-an-amazon-rekognition-custom-labels-project-1690405898597
|
|
109
108
|
* ```
|
|
110
109
|
*
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
export declare class CreateProjectCommand extends CreateProjectCommand_base {
|
|
113
113
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -159,28 +159,28 @@ declare const CreateProjectVersionCommand_base: {
|
|
|
159
159
|
* @throws {@link RekognitionServiceException}
|
|
160
160
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
161
161
|
*
|
|
162
|
-
*
|
|
162
|
+
*
|
|
163
163
|
* @example To train an Amazon Rekognition Custom Labels model
|
|
164
164
|
* ```javascript
|
|
165
165
|
* // Trains a version of an Amazon Rekognition Custom Labels model.
|
|
166
166
|
* const input = {
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
167
|
+
* OutputConfig: {
|
|
168
|
+
* S3Bucket: "output_bucket",
|
|
169
|
+
* S3KeyPrefix: "output_folder"
|
|
170
170
|
* },
|
|
171
|
-
*
|
|
172
|
-
*
|
|
171
|
+
* ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
|
|
172
|
+
* VersionName: "1"
|
|
173
173
|
* };
|
|
174
174
|
* const command = new CreateProjectVersionCommand(input);
|
|
175
175
|
* const response = await client.send(command);
|
|
176
|
-
* /* response
|
|
176
|
+
* /* response is
|
|
177
177
|
* {
|
|
178
|
-
*
|
|
178
|
+
* ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
|
|
179
179
|
* }
|
|
180
180
|
* *\/
|
|
181
|
-
* // example id: to-train-an-amazon-rekognition-custom-labels-model-1690555832843
|
|
182
181
|
* ```
|
|
183
182
|
*
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
export declare class CreateProjectVersionCommand extends CreateProjectVersionCommand_base {
|
|
186
186
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -169,6 +169,7 @@ declare const CreateStreamProcessorCommand_base: {
|
|
|
169
169
|
* @throws {@link RekognitionServiceException}
|
|
170
170
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
171
171
|
*
|
|
172
|
+
*
|
|
172
173
|
* @public
|
|
173
174
|
*/
|
|
174
175
|
export declare class CreateStreamProcessorCommand extends CreateStreamProcessorCommand_base {
|
|
@@ -94,19 +94,22 @@ declare const CreateUserCommand_base: {
|
|
|
94
94
|
* @throws {@link RekognitionServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
96
96
|
*
|
|
97
|
-
*
|
|
97
|
+
*
|
|
98
98
|
* @example CreateUser
|
|
99
99
|
* ```javascript
|
|
100
100
|
* // Creates a new User within a collection specified by CollectionId.
|
|
101
101
|
* const input = {
|
|
102
|
-
*
|
|
103
|
-
*
|
|
102
|
+
* CollectionId: "MyCollection",
|
|
103
|
+
* UserId: "DemoUser"
|
|
104
104
|
* };
|
|
105
105
|
* const command = new CreateUserCommand(input);
|
|
106
|
-
* await client.send(command);
|
|
107
|
-
*
|
|
106
|
+
* const response = await client.send(command);
|
|
107
|
+
* /* response is
|
|
108
|
+
* { /* metadata only *\/ }
|
|
109
|
+
* *\/
|
|
108
110
|
* ```
|
|
109
111
|
*
|
|
112
|
+
* @public
|
|
110
113
|
*/
|
|
111
114
|
export declare class CreateUserCommand extends CreateUserCommand_base {
|
|
112
115
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,23 +78,23 @@ declare const DeleteCollectionCommand_base: {
|
|
|
78
78
|
* @throws {@link RekognitionServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
*
|
|
82
82
|
* @example To delete a collection
|
|
83
83
|
* ```javascript
|
|
84
84
|
* // This operation deletes a Rekognition collection.
|
|
85
85
|
* const input = {
|
|
86
|
-
*
|
|
86
|
+
* CollectionId: "myphotos"
|
|
87
87
|
* };
|
|
88
88
|
* const command = new DeleteCollectionCommand(input);
|
|
89
89
|
* const response = await client.send(command);
|
|
90
|
-
* /* response
|
|
90
|
+
* /* response is
|
|
91
91
|
* {
|
|
92
|
-
*
|
|
92
|
+
* StatusCode: 200
|
|
93
93
|
* }
|
|
94
94
|
* *\/
|
|
95
|
-
* // example id: to-delete-a-collection-1481838179973
|
|
96
95
|
* ```
|
|
97
96
|
*
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export declare class DeleteCollectionCommand extends DeleteCollectionCommand_base {
|
|
100
100
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -94,18 +94,21 @@ declare const DeleteDatasetCommand_base: {
|
|
|
94
94
|
* @throws {@link RekognitionServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
96
96
|
*
|
|
97
|
-
*
|
|
97
|
+
*
|
|
98
98
|
* @example To delete an Amazon Rekognition Custom Labels dataset
|
|
99
99
|
* ```javascript
|
|
100
100
|
* // Deletes an Amazon Rekognition Custom Labels dataset.
|
|
101
101
|
* const input = {
|
|
102
|
-
*
|
|
102
|
+
* DatasetArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321"
|
|
103
103
|
* };
|
|
104
104
|
* const command = new DeleteDatasetCommand(input);
|
|
105
|
-
* await client.send(command);
|
|
106
|
-
*
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response is
|
|
107
|
+
* { /* empty *\/ }
|
|
108
|
+
* *\/
|
|
107
109
|
* ```
|
|
108
110
|
*
|
|
111
|
+
* @public
|
|
109
112
|
*/
|
|
110
113
|
export declare class DeleteDatasetCommand extends DeleteDatasetCommand_base {
|
|
111
114
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -91,28 +91,28 @@ declare const DeleteFacesCommand_base: {
|
|
|
91
91
|
* @throws {@link RekognitionServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To delete a face
|
|
96
96
|
* ```javascript
|
|
97
97
|
* // This operation deletes one or more faces from a Rekognition collection.
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
99
|
+
* CollectionId: "myphotos",
|
|
100
|
+
* FaceIds: [
|
|
101
101
|
* "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
|
|
102
102
|
* ]
|
|
103
103
|
* };
|
|
104
104
|
* const command = new DeleteFacesCommand(input);
|
|
105
105
|
* const response = await client.send(command);
|
|
106
|
-
* /* response
|
|
106
|
+
* /* response is
|
|
107
107
|
* {
|
|
108
|
-
*
|
|
108
|
+
* DeletedFaces: [
|
|
109
109
|
* "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
|
|
110
110
|
* ]
|
|
111
111
|
* }
|
|
112
112
|
* *\/
|
|
113
|
-
* // example id: to-delete-a-face-1482182799377
|
|
114
113
|
* ```
|
|
115
114
|
*
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
export declare class DeleteFacesCommand extends DeleteFacesCommand_base {
|
|
118
118
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,23 +85,23 @@ declare const DeleteProjectCommand_base: {
|
|
|
85
85
|
* @throws {@link RekognitionServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To delete an Amazon Rekognition Custom Labels project
|
|
90
90
|
* ```javascript
|
|
91
91
|
* // Deletes an Amazon Rekognition Custom Labels projects.
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
93
|
+
* ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new DeleteProjectCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
99
|
+
* Status: "DELETING"
|
|
100
100
|
* }
|
|
101
101
|
* *\/
|
|
102
|
-
* // example id: to-delete-an-amazon-rekognition-custom-labels-project-1690409093478
|
|
103
102
|
* ```
|
|
104
103
|
*
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export declare class DeleteProjectCommand extends DeleteProjectCommand_base {
|
|
107
107
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,20 +82,23 @@ declare const DeleteProjectPolicyCommand_base: {
|
|
|
82
82
|
* @throws {@link RekognitionServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
84
84
|
*
|
|
85
|
-
*
|
|
85
|
+
*
|
|
86
86
|
* @example DeleteProjectPolicy
|
|
87
87
|
* ```javascript
|
|
88
88
|
* // This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project.
|
|
89
89
|
* const input = {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
90
|
+
* PolicyName: "testPolicy1",
|
|
91
|
+
* PolicyRevisionId: "3b274c25e9203a56a99e00e3ff205fbc",
|
|
92
|
+
* ProjectArn: "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456"
|
|
93
93
|
* };
|
|
94
94
|
* const command = new DeleteProjectPolicyCommand(input);
|
|
95
|
-
* await client.send(command);
|
|
96
|
-
*
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response is
|
|
97
|
+
* { /* empty *\/ }
|
|
98
|
+
* *\/
|
|
97
99
|
* ```
|
|
98
100
|
*
|
|
101
|
+
* @public
|
|
99
102
|
*/
|
|
100
103
|
export declare class DeleteProjectPolicyCommand extends DeleteProjectPolicyCommand_base {
|
|
101
104
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,23 +83,23 @@ declare const DeleteProjectVersionCommand_base: {
|
|
|
83
83
|
* @throws {@link RekognitionServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
*
|
|
87
87
|
* @example To delete an Amazon Rekognition Custom Labels model
|
|
88
88
|
* ```javascript
|
|
89
89
|
* // Deletes a version of an Amazon Rekognition Custom Labels model.
|
|
90
90
|
* const input = {
|
|
91
|
-
*
|
|
91
|
+
* ProjectVersionArn: "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
|
|
92
92
|
* };
|
|
93
93
|
* const command = new DeleteProjectVersionCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
-
* /* response
|
|
95
|
+
* /* response is
|
|
96
96
|
* {
|
|
97
|
-
*
|
|
97
|
+
* Status: "DELETING"
|
|
98
98
|
* }
|
|
99
99
|
* *\/
|
|
100
|
-
* // example id: to-delete-an-amazon-rekognition-custom-labels-model-1690827562055
|
|
101
100
|
* ```
|
|
102
101
|
*
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
export declare class DeleteProjectVersionCommand extends DeleteProjectVersionCommand_base {
|
|
105
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -76,6 +76,7 @@ declare const DeleteStreamProcessorCommand_base: {
|
|
|
76
76
|
* @throws {@link RekognitionServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
78
78
|
*
|
|
79
|
+
*
|
|
79
80
|
* @public
|
|
80
81
|
*/
|
|
81
82
|
export declare class DeleteStreamProcessorCommand extends DeleteStreamProcessorCommand_base {
|
|
@@ -86,20 +86,23 @@ declare const DeleteUserCommand_base: {
|
|
|
86
86
|
* @throws {@link RekognitionServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
88
88
|
*
|
|
89
|
-
*
|
|
89
|
+
*
|
|
90
90
|
* @example DeleteUser
|
|
91
91
|
* ```javascript
|
|
92
92
|
* // Deletes the specified UserID within the collection.
|
|
93
93
|
* const input = {
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
94
|
+
* ClientRequestToken: "550e8400-e29b-41d4-a716-446655440001",
|
|
95
|
+
* CollectionId: "MyCollection",
|
|
96
|
+
* UserId: "DemoUser"
|
|
97
97
|
* };
|
|
98
98
|
* const command = new DeleteUserCommand(input);
|
|
99
|
-
* await client.send(command);
|
|
100
|
-
*
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response is
|
|
101
|
+
* { /* metadata only *\/ }
|
|
102
|
+
* *\/
|
|
101
103
|
* ```
|
|
102
104
|
*
|
|
105
|
+
* @public
|
|
103
106
|
*/
|
|
104
107
|
export declare class DeleteUserCommand extends DeleteUserCommand_base {
|
|
105
108
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,6 +82,7 @@ declare const DescribeCollectionCommand_base: {
|
|
|
82
82
|
* @throws {@link RekognitionServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
84
84
|
*
|
|
85
|
+
*
|
|
85
86
|
* @public
|
|
86
87
|
*/
|
|
87
88
|
export declare class DescribeCollectionCommand extends DescribeCollectionCommand_base {
|