@aws-sdk/client-rekognition 3.325.0 → 3.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/dist-types/commands/CompareFacesCommand.d.ts +88 -0
  2. package/dist-types/commands/CopyProjectVersionCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateCollectionCommand.d.ts +8 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  5. package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +6 -0
  6. package/dist-types/commands/CreateProjectCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateProjectVersionCommand.d.ts +6 -0
  8. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +6 -0
  9. package/dist-types/commands/DeleteCollectionCommand.d.ts +6 -0
  10. package/dist-types/commands/DeleteDatasetCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteFacesCommand.d.ts +8 -0
  12. package/dist-types/commands/DeleteProjectCommand.d.ts +6 -0
  13. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +6 -0
  15. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +4 -0
  16. package/dist-types/commands/DescribeCollectionCommand.d.ts +9 -0
  17. package/dist-types/commands/DescribeDatasetCommand.d.ts +18 -0
  18. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +105 -0
  19. package/dist-types/commands/DescribeProjectsCommand.d.ts +23 -0
  20. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +61 -0
  21. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +25 -0
  22. package/dist-types/commands/DetectFacesCommand.d.ts +75 -0
  23. package/dist-types/commands/DetectLabelsCommand.d.ts +84 -0
  24. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +20 -0
  25. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +51 -0
  26. package/dist-types/commands/DetectTextCommand.d.ts +29 -0
  27. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +4 -0
  28. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +12 -0
  29. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +115 -0
  30. package/dist-types/commands/GetContentModerationCommand.d.ts +44 -0
  31. package/dist-types/commands/GetFaceDetectionCommand.d.ts +98 -0
  32. package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +38 -0
  33. package/dist-types/commands/GetFaceSearchCommand.d.ts +120 -0
  34. package/dist-types/commands/GetLabelDetectionCommand.d.ts +80 -0
  35. package/dist-types/commands/GetPersonTrackingCommand.d.ts +107 -0
  36. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +64 -0
  37. package/dist-types/commands/GetTextDetectionCommand.d.ts +53 -0
  38. package/dist-types/commands/IndexFacesCommand.d.ts +165 -0
  39. package/dist-types/commands/ListCollectionsCommand.d.ts +12 -0
  40. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +9 -0
  41. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +15 -0
  42. package/dist-types/commands/ListFacesCommand.d.ts +22 -0
  43. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
  44. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +12 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  46. package/dist-types/commands/PutProjectPolicyCommand.d.ts +6 -0
  47. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +91 -0
  48. package/dist-types/commands/SearchFacesByImageCommand.d.ts +31 -0
  49. package/dist-types/commands/SearchFacesCommand.d.ts +25 -0
  50. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +6 -0
  51. package/dist-types/commands/StartContentModerationCommand.d.ts +6 -0
  52. package/dist-types/commands/StartFaceDetectionCommand.d.ts +6 -0
  53. package/dist-types/commands/StartFaceSearchCommand.d.ts +6 -0
  54. package/dist-types/commands/StartLabelDetectionCommand.d.ts +6 -0
  55. package/dist-types/commands/StartPersonTrackingCommand.d.ts +6 -0
  56. package/dist-types/commands/StartProjectVersionCommand.d.ts +6 -0
  57. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +6 -0
  58. package/dist-types/commands/StartStreamProcessorCommand.d.ts +6 -0
  59. package/dist-types/commands/StartTextDetectionCommand.d.ts +6 -0
  60. package/dist-types/commands/StopProjectVersionCommand.d.ts +6 -0
  61. package/dist-types/commands/StopStreamProcessorCommand.d.ts +4 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  64. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +4 -0
  65. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +4 -0
  66. package/package.json +3 -3
@@ -98,6 +98,92 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
98
98
  * };
99
99
  * const command = new CompareFacesCommand(input);
100
100
  * const response = await client.send(command);
101
+ * // { // CompareFacesResponse
102
+ * // SourceImageFace: { // ComparedSourceImageFace
103
+ * // BoundingBox: { // BoundingBox
104
+ * // Width: Number("float"),
105
+ * // Height: Number("float"),
106
+ * // Left: Number("float"),
107
+ * // Top: Number("float"),
108
+ * // },
109
+ * // Confidence: Number("float"),
110
+ * // },
111
+ * // FaceMatches: [ // CompareFacesMatchList
112
+ * // { // CompareFacesMatch
113
+ * // Similarity: Number("float"),
114
+ * // Face: { // ComparedFace
115
+ * // BoundingBox: {
116
+ * // Width: Number("float"),
117
+ * // Height: Number("float"),
118
+ * // Left: Number("float"),
119
+ * // Top: Number("float"),
120
+ * // },
121
+ * // Confidence: Number("float"),
122
+ * // Landmarks: [ // Landmarks
123
+ * // { // Landmark
124
+ * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
125
+ * // X: Number("float"),
126
+ * // Y: Number("float"),
127
+ * // },
128
+ * // ],
129
+ * // Pose: { // Pose
130
+ * // Roll: Number("float"),
131
+ * // Yaw: Number("float"),
132
+ * // Pitch: Number("float"),
133
+ * // },
134
+ * // Quality: { // ImageQuality
135
+ * // Brightness: Number("float"),
136
+ * // Sharpness: Number("float"),
137
+ * // },
138
+ * // Emotions: [ // Emotions
139
+ * // { // Emotion
140
+ * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
141
+ * // Confidence: Number("float"),
142
+ * // },
143
+ * // ],
144
+ * // Smile: { // Smile
145
+ * // Value: true || false,
146
+ * // Confidence: Number("float"),
147
+ * // },
148
+ * // },
149
+ * // },
150
+ * // ],
151
+ * // UnmatchedFaces: [ // CompareFacesUnmatchList
152
+ * // {
153
+ * // BoundingBox: "<BoundingBox>",
154
+ * // Confidence: Number("float"),
155
+ * // Landmarks: [
156
+ * // {
157
+ * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
158
+ * // X: Number("float"),
159
+ * // Y: Number("float"),
160
+ * // },
161
+ * // ],
162
+ * // Pose: {
163
+ * // Roll: Number("float"),
164
+ * // Yaw: Number("float"),
165
+ * // Pitch: Number("float"),
166
+ * // },
167
+ * // Quality: {
168
+ * // Brightness: Number("float"),
169
+ * // Sharpness: Number("float"),
170
+ * // },
171
+ * // Emotions: [
172
+ * // {
173
+ * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
174
+ * // Confidence: Number("float"),
175
+ * // },
176
+ * // ],
177
+ * // Smile: {
178
+ * // Value: true || false,
179
+ * // Confidence: Number("float"),
180
+ * // },
181
+ * // },
182
+ * // ],
183
+ * // SourceImageOrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270",
184
+ * // TargetImageOrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270",
185
+ * // };
186
+ *
101
187
  * ```
102
188
  *
103
189
  * @param CompareFacesCommandInput - {@link CompareFacesCommandInput}
@@ -135,6 +221,8 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
135
221
  * @throws {@link ThrottlingException} (server fault)
136
222
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
137
223
  *
224
+ * @throws {@link RekognitionServiceException}
225
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
138
226
  *
139
227
  * @example To compare two images
140
228
  * ```javascript
@@ -61,6 +61,10 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
61
61
  * };
62
62
  * const command = new CopyProjectVersionCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // CopyProjectVersionResponse
65
+ * // ProjectVersionArn: "STRING_VALUE",
66
+ * // };
67
+ *
64
68
  * ```
65
69
  *
66
70
  * @param CopyProjectVersionCommandInput - {@link CopyProjectVersionCommandInput}
@@ -102,6 +106,8 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
102
106
  * @throws {@link ThrottlingException} (server fault)
103
107
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
104
108
  *
109
+ * @throws {@link RekognitionServiceException}
110
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
105
111
  *
106
112
  * @example CopyProjectVersion
107
113
  * ```javascript
@@ -48,6 +48,12 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
48
48
  * };
49
49
  * const command = new CreateCollectionCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // CreateCollectionResponse
52
+ * // StatusCode: Number("int"),
53
+ * // CollectionArn: "STRING_VALUE",
54
+ * // FaceModelVersion: "STRING_VALUE",
55
+ * // };
56
+ *
51
57
  * ```
52
58
  *
53
59
  * @param CreateCollectionCommandInput - {@link CreateCollectionCommandInput}
@@ -81,6 +87,8 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
81
87
  * @throws {@link ThrottlingException} (server fault)
82
88
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
83
89
  *
90
+ * @throws {@link RekognitionServiceException}
91
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
84
92
  *
85
93
  * @example To create a collection
86
94
  * ```javascript
@@ -60,6 +60,10 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
60
60
  * };
61
61
  * const command = new CreateDatasetCommand(input);
62
62
  * const response = await client.send(command);
63
+ * // { // CreateDatasetResponse
64
+ * // DatasetArn: "STRING_VALUE",
65
+ * // };
66
+ *
63
67
  * ```
64
68
  *
65
69
  * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
@@ -99,6 +103,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
99
103
  * @throws {@link ThrottlingException} (server fault)
100
104
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
101
105
  *
106
+ * @throws {@link RekognitionServiceException}
107
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
102
108
  *
103
109
  */
104
110
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, RekognitionClientResolvedConfig> {
@@ -45,6 +45,10 @@ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivene
45
45
  * };
46
46
  * const command = new CreateFaceLivenessSessionCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // CreateFaceLivenessSessionResponse
49
+ * // SessionId: "STRING_VALUE", // required
50
+ * // };
51
+ *
48
52
  * ```
49
53
  *
50
54
  * @param CreateFaceLivenessSessionCommandInput - {@link CreateFaceLivenessSessionCommandInput}
@@ -70,6 +74,8 @@ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivene
70
74
  * @throws {@link ThrottlingException} (server fault)
71
75
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
72
76
  *
77
+ * @throws {@link RekognitionServiceException}
78
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
73
79
  *
74
80
  */
75
81
  export declare class CreateFaceLivenessSessionCommand extends $Command<CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput, RekognitionClientResolvedConfig> {
@@ -33,6 +33,10 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
33
33
  * };
34
34
  * const command = new CreateProjectCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // CreateProjectResponse
37
+ * // ProjectArn: "STRING_VALUE",
38
+ * // };
39
+ *
36
40
  * ```
37
41
  *
38
42
  * @param CreateProjectCommandInput - {@link CreateProjectCommandInput}
@@ -66,6 +70,8 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
66
70
  * @throws {@link ThrottlingException} (server fault)
67
71
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
68
72
  *
73
+ * @throws {@link RekognitionServiceException}
74
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
69
75
  *
70
76
  */
71
77
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, RekognitionClientResolvedConfig> {
@@ -96,6 +96,10 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
96
96
  * };
97
97
  * const command = new CreateProjectVersionCommand(input);
98
98
  * const response = await client.send(command);
99
+ * // { // CreateProjectVersionResponse
100
+ * // ProjectVersionArn: "STRING_VALUE",
101
+ * // };
102
+ *
99
103
  * ```
100
104
  *
101
105
  * @param CreateProjectVersionCommandInput - {@link CreateProjectVersionCommandInput}
@@ -137,6 +141,8 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
137
141
  * @throws {@link ThrottlingException} (server fault)
138
142
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
139
143
  *
144
+ * @throws {@link RekognitionServiceException}
145
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
140
146
  *
141
147
  */
142
148
  export declare class CreateProjectVersionCommand extends $Command<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
@@ -114,6 +114,10 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
114
114
  * };
115
115
  * const command = new CreateStreamProcessorCommand(input);
116
116
  * const response = await client.send(command);
117
+ * // { // CreateStreamProcessorResponse
118
+ * // StreamProcessorArn: "STRING_VALUE",
119
+ * // };
120
+ *
117
121
  * ```
118
122
  *
119
123
  * @param CreateStreamProcessorCommandInput - {@link CreateStreamProcessorCommandInput}
@@ -152,6 +156,8 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
152
156
  * @throws {@link ThrottlingException} (server fault)
153
157
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
154
158
  *
159
+ * @throws {@link RekognitionServiceException}
160
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
155
161
  *
156
162
  */
157
163
  export declare class CreateStreamProcessorCommand extends $Command<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
35
35
  * };
36
36
  * const command = new DeleteCollectionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DeleteCollectionResponse
39
+ * // StatusCode: Number("int"),
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param DeleteCollectionCommandInput - {@link DeleteCollectionCommandInput}
@@ -63,6 +67,8 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
63
67
  * @throws {@link ThrottlingException} (server fault)
64
68
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
65
69
  *
70
+ * @throws {@link RekognitionServiceException}
71
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
66
72
  *
67
73
  * @example To delete a collection
68
74
  * ```javascript
@@ -40,6 +40,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
40
40
  * };
41
41
  * const command = new DeleteDatasetCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
@@ -76,6 +78,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
76
78
  * @throws {@link ThrottlingException} (server fault)
77
79
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
78
80
  *
81
+ * @throws {@link RekognitionServiceException}
82
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
79
83
  *
80
84
  */
81
85
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, RekognitionClientResolvedConfig> {
@@ -37,6 +37,12 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
37
37
  * };
38
38
  * const command = new DeleteFacesCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // DeleteFacesResponse
41
+ * // DeletedFaces: [ // FaceIdList
42
+ * // "STRING_VALUE",
43
+ * // ],
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param DeleteFacesCommandInput - {@link DeleteFacesCommandInput}
@@ -65,6 +71,8 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
65
71
  * @throws {@link ThrottlingException} (server fault)
66
72
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
67
73
  *
74
+ * @throws {@link RekognitionServiceException}
75
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
68
76
  *
69
77
  * @example To delete a face
70
78
  * ```javascript
@@ -39,6 +39,10 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
39
39
  * };
40
40
  * const command = new DeleteProjectCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // DeleteProjectResponse
43
+ * // Status: "CREATING" || "CREATED" || "DELETING",
44
+ * // };
45
+ *
42
46
  * ```
43
47
  *
44
48
  * @param DeleteProjectCommandInput - {@link DeleteProjectCommandInput}
@@ -70,6 +74,8 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
70
74
  * @throws {@link ThrottlingException} (server fault)
71
75
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
72
76
  *
77
+ * @throws {@link RekognitionServiceException}
78
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
73
79
  *
74
80
  */
75
81
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, RekognitionClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
35
35
  * };
36
36
  * const command = new DeleteProjectPolicyCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param DeleteProjectPolicyCommandInput - {@link DeleteProjectPolicyCommandInput}
@@ -66,6 +68,8 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
66
68
  * @throws {@link ThrottlingException} (server fault)
67
69
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
68
70
  *
71
+ * @throws {@link RekognitionServiceException}
72
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
69
73
  *
70
74
  * @example DeleteProjectPolicy
71
75
  * ```javascript
@@ -38,6 +38,10 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
38
38
  * };
39
39
  * const command = new DeleteProjectVersionCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DeleteProjectVersionResponse
42
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
43
+ * // };
44
+ *
41
45
  * ```
42
46
  *
43
47
  * @param DeleteProjectVersionCommandInput - {@link DeleteProjectVersionCommandInput}
@@ -69,6 +73,8 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
69
73
  * @throws {@link ThrottlingException} (server fault)
70
74
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
71
75
  *
76
+ * @throws {@link RekognitionServiceException}
77
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
72
78
  *
73
79
  */
74
80
  export declare class DeleteProjectVersionCommand extends $Command<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
32
32
  * };
33
33
  * const command = new DeleteStreamProcessorCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteStreamProcessorCommandInput - {@link DeleteStreamProcessorCommandInput}
@@ -63,6 +65,8 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
63
65
  * @throws {@link ThrottlingException} (server fault)
64
66
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
65
67
  *
68
+ * @throws {@link RekognitionServiceException}
69
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
66
70
  *
67
71
  */
68
72
  export declare class DeleteStreamProcessorCommand extends $Command<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
@@ -35,6 +35,13 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
35
35
  * };
36
36
  * const command = new DescribeCollectionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeCollectionResponse
39
+ * // FaceCount: Number("long"),
40
+ * // FaceModelVersion: "STRING_VALUE",
41
+ * // CollectionARN: "STRING_VALUE",
42
+ * // CreationTimestamp: new Date("TIMESTAMP"),
43
+ * // };
44
+ *
38
45
  * ```
39
46
  *
40
47
  * @param DescribeCollectionCommandInput - {@link DescribeCollectionCommandInput}
@@ -63,6 +70,8 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
63
70
  * @throws {@link ThrottlingException} (server fault)
64
71
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
65
72
  *
73
+ * @throws {@link RekognitionServiceException}
74
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
66
75
  *
67
76
  */
68
77
  export declare class DescribeCollectionCommand extends $Command<DescribeCollectionCommandInput, DescribeCollectionCommandOutput, RekognitionClientResolvedConfig> {
@@ -35,6 +35,22 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
35
35
  * };
36
36
  * const command = new DescribeDatasetCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeDatasetResponse
39
+ * // DatasetDescription: { // DatasetDescription
40
+ * // CreationTimestamp: new Date("TIMESTAMP"),
41
+ * // LastUpdatedTimestamp: new Date("TIMESTAMP"),
42
+ * // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS",
43
+ * // StatusMessage: "STRING_VALUE",
44
+ * // StatusMessageCode: "SUCCESS" || "SERVICE_ERROR" || "CLIENT_ERROR",
45
+ * // DatasetStats: { // DatasetStats
46
+ * // LabeledEntries: Number("int"),
47
+ * // TotalEntries: Number("int"),
48
+ * // TotalLabels: Number("int"),
49
+ * // ErrorEntries: Number("int"),
50
+ * // },
51
+ * // },
52
+ * // };
53
+ *
38
54
  * ```
39
55
  *
40
56
  * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
@@ -63,6 +79,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
63
79
  * @throws {@link ThrottlingException} (server fault)
64
80
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
65
81
  *
82
+ * @throws {@link RekognitionServiceException}
83
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
66
84
  *
67
85
  */
68
86
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, RekognitionClientResolvedConfig> {
@@ -40,6 +40,109 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
40
40
  * };
41
41
  * const command = new DescribeProjectVersionsCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // DescribeProjectVersionsResponse
44
+ * // ProjectVersionDescriptions: [ // ProjectVersionDescriptions
45
+ * // { // ProjectVersionDescription
46
+ * // ProjectVersionArn: "STRING_VALUE",
47
+ * // CreationTimestamp: new Date("TIMESTAMP"),
48
+ * // MinInferenceUnits: Number("int"),
49
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
50
+ * // StatusMessage: "STRING_VALUE",
51
+ * // BillableTrainingTimeInSeconds: Number("long"),
52
+ * // TrainingEndTimestamp: new Date("TIMESTAMP"),
53
+ * // OutputConfig: { // OutputConfig
54
+ * // S3Bucket: "STRING_VALUE",
55
+ * // S3KeyPrefix: "STRING_VALUE",
56
+ * // },
57
+ * // TrainingDataResult: { // TrainingDataResult
58
+ * // Input: { // TrainingData
59
+ * // Assets: [ // Assets
60
+ * // { // Asset
61
+ * // GroundTruthManifest: { // GroundTruthManifest
62
+ * // S3Object: { // S3Object
63
+ * // Bucket: "STRING_VALUE",
64
+ * // Name: "STRING_VALUE",
65
+ * // Version: "STRING_VALUE",
66
+ * // },
67
+ * // },
68
+ * // },
69
+ * // ],
70
+ * // },
71
+ * // Output: {
72
+ * // Assets: [
73
+ * // {
74
+ * // GroundTruthManifest: {
75
+ * // S3Object: {
76
+ * // Bucket: "STRING_VALUE",
77
+ * // Name: "STRING_VALUE",
78
+ * // Version: "STRING_VALUE",
79
+ * // },
80
+ * // },
81
+ * // },
82
+ * // ],
83
+ * // },
84
+ * // Validation: { // ValidationData
85
+ * // Assets: [
86
+ * // {
87
+ * // GroundTruthManifest: {
88
+ * // S3Object: {
89
+ * // Bucket: "STRING_VALUE",
90
+ * // Name: "STRING_VALUE",
91
+ * // Version: "STRING_VALUE",
92
+ * // },
93
+ * // },
94
+ * // },
95
+ * // ],
96
+ * // },
97
+ * // },
98
+ * // TestingDataResult: { // TestingDataResult
99
+ * // Input: { // TestingData
100
+ * // Assets: [
101
+ * // {
102
+ * // GroundTruthManifest: {
103
+ * // S3Object: {
104
+ * // Bucket: "STRING_VALUE",
105
+ * // Name: "STRING_VALUE",
106
+ * // Version: "STRING_VALUE",
107
+ * // },
108
+ * // },
109
+ * // },
110
+ * // ],
111
+ * // AutoCreate: true || false,
112
+ * // },
113
+ * // Output: {
114
+ * // Assets: [
115
+ * // {
116
+ * // GroundTruthManifest: {
117
+ * // S3Object: {
118
+ * // Bucket: "STRING_VALUE",
119
+ * // Name: "STRING_VALUE",
120
+ * // Version: "STRING_VALUE",
121
+ * // },
122
+ * // },
123
+ * // },
124
+ * // ],
125
+ * // AutoCreate: true || false,
126
+ * // },
127
+ * // Validation: {
128
+ * // Assets: "<Assets>",
129
+ * // },
130
+ * // },
131
+ * // EvaluationResult: { // EvaluationResult
132
+ * // F1Score: Number("float"),
133
+ * // Summary: { // Summary
134
+ * // S3Object: "<S3Object>",
135
+ * // },
136
+ * // },
137
+ * // ManifestSummary: "<GroundTruthManifest>",
138
+ * // KmsKeyId: "STRING_VALUE",
139
+ * // MaxInferenceUnits: Number("int"),
140
+ * // SourceProjectVersionArn: "STRING_VALUE",
141
+ * // },
142
+ * // ],
143
+ * // NextToken: "STRING_VALUE",
144
+ * // };
145
+ *
43
146
  * ```
44
147
  *
45
148
  * @param DescribeProjectVersionsCommandInput - {@link DescribeProjectVersionsCommandInput}
@@ -71,6 +174,8 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
71
174
  * @throws {@link ThrottlingException} (server fault)
72
175
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
73
176
  *
177
+ * @throws {@link RekognitionServiceException}
178
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
74
179
  *
75
180
  */
76
181
  export declare class DescribeProjectVersionsCommand extends $Command<DescribeProjectVersionsCommandInput, DescribeProjectVersionsCommandOutput, RekognitionClientResolvedConfig> {
@@ -36,6 +36,27 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
36
36
  * };
37
37
  * const command = new DescribeProjectsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeProjectsResponse
40
+ * // ProjectDescriptions: [ // ProjectDescriptions
41
+ * // { // ProjectDescription
42
+ * // ProjectArn: "STRING_VALUE",
43
+ * // CreationTimestamp: new Date("TIMESTAMP"),
44
+ * // Status: "CREATING" || "CREATED" || "DELETING",
45
+ * // Datasets: [ // DatasetMetadataList
46
+ * // { // DatasetMetadata
47
+ * // CreationTimestamp: new Date("TIMESTAMP"),
48
+ * // DatasetType: "TRAIN" || "TEST",
49
+ * // DatasetArn: "STRING_VALUE",
50
+ * // Status: "CREATE_IN_PROGRESS" || "CREATE_COMPLETE" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS",
51
+ * // StatusMessage: "STRING_VALUE",
52
+ * // StatusMessageCode: "SUCCESS" || "SERVICE_ERROR" || "CLIENT_ERROR",
53
+ * // },
54
+ * // ],
55
+ * // },
56
+ * // ],
57
+ * // NextToken: "STRING_VALUE",
58
+ * // };
59
+ *
39
60
  * ```
40
61
  *
41
62
  * @param DescribeProjectsCommandInput - {@link DescribeProjectsCommandInput}
@@ -64,6 +85,8 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
64
85
  * @throws {@link ThrottlingException} (server fault)
65
86
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
66
87
  *
88
+ * @throws {@link RekognitionServiceException}
89
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
67
90
  *
68
91
  */
69
92
  export declare class DescribeProjectsCommand extends $Command<DescribeProjectsCommandInput, DescribeProjectsCommandOutput, RekognitionClientResolvedConfig> {