@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.
Files changed (64) hide show
  1. package/dist-types/commands/CompareFacesCommand.d.ts +80 -0
  2. package/dist-types/commands/CopyProjectVersionCommand.d.ts +61 -0
  3. package/dist-types/commands/CreateCollectionCommand.d.ts +43 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +32 -0
  5. package/dist-types/commands/CreateProjectCommand.d.ts +26 -0
  6. package/dist-types/commands/CreateProjectVersionCommand.d.ts +34 -0
  7. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +31 -0
  8. package/dist-types/commands/DeleteCollectionCommand.d.ts +37 -0
  9. package/dist-types/commands/DeleteDatasetCommand.d.ts +29 -0
  10. package/dist-types/commands/DeleteFacesCommand.d.ts +42 -0
  11. package/dist-types/commands/DeleteProjectCommand.d.ts +24 -0
  12. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +37 -0
  13. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +24 -0
  14. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +24 -0
  15. package/dist-types/commands/DescribeCollectionCommand.d.ts +21 -0
  16. package/dist-types/commands/DescribeDatasetCommand.d.ts +21 -0
  17. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +24 -0
  18. package/dist-types/commands/DescribeProjectsCommand.d.ts +21 -0
  19. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +21 -0
  20. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +43 -0
  21. package/dist-types/commands/DetectFacesCommand.d.ts +98 -0
  22. package/dist-types/commands/DetectLabelsCommand.d.ts +62 -0
  23. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +33 -0
  24. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +30 -0
  25. package/dist-types/commands/DetectTextCommand.d.ts +30 -0
  26. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +26 -0
  27. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +21 -0
  28. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +24 -0
  29. package/dist-types/commands/GetContentModerationCommand.d.ts +24 -0
  30. package/dist-types/commands/GetFaceDetectionCommand.d.ts +24 -0
  31. package/dist-types/commands/GetFaceSearchCommand.d.ts +24 -0
  32. package/dist-types/commands/GetLabelDetectionCommand.d.ts +24 -0
  33. package/dist-types/commands/GetPersonTrackingCommand.d.ts +24 -0
  34. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +24 -0
  35. package/dist-types/commands/GetTextDetectionCommand.d.ts +24 -0
  36. package/dist-types/commands/IndexFacesCommand.d.ts +180 -0
  37. package/dist-types/commands/ListCollectionsCommand.d.ts +40 -0
  38. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +32 -0
  39. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +32 -0
  40. package/dist-types/commands/ListFacesCommand.d.ts +163 -0
  41. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +52 -0
  42. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +21 -0
  43. package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
  44. package/dist-types/commands/PutProjectPolicyCommand.d.ts +60 -0
  45. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +30 -0
  46. package/dist-types/commands/SearchFacesByImageCommand.d.ts +79 -0
  47. package/dist-types/commands/SearchFacesCommand.d.ts +84 -0
  48. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +34 -0
  49. package/dist-types/commands/StartContentModerationCommand.d.ts +34 -0
  50. package/dist-types/commands/StartFaceDetectionCommand.d.ts +34 -0
  51. package/dist-types/commands/StartFaceSearchCommand.d.ts +37 -0
  52. package/dist-types/commands/StartLabelDetectionCommand.d.ts +34 -0
  53. package/dist-types/commands/StartPersonTrackingCommand.d.ts +34 -0
  54. package/dist-types/commands/StartProjectVersionCommand.d.ts +29 -0
  55. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +34 -0
  56. package/dist-types/commands/StartStreamProcessorCommand.d.ts +24 -0
  57. package/dist-types/commands/StartTextDetectionCommand.d.ts +34 -0
  58. package/dist-types/commands/StopProjectVersionCommand.d.ts +24 -0
  59. package/dist-types/commands/StopStreamProcessorCommand.d.ts +24 -0
  60. package/dist-types/commands/TagResourceCommand.d.ts +26 -0
  61. package/dist-types/commands/UntagResourceCommand.d.ts +21 -0
  62. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +29 -0
  63. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +21 -0
  64. package/package.json +30 -30
@@ -79,6 +79,86 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
79
79
  * @see {@link CompareFacesCommandOutput} for command's `response` shape.
80
80
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
81
81
  *
82
+ * @throws {@link AccessDeniedException} (client fault)
83
+ * <p>You are not authorized to perform the action.</p>
84
+ *
85
+ * @throws {@link ImageTooLargeException} (client fault)
86
+ * <p>The input image size exceeds the allowed limit. If you are calling
87
+ * DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more
88
+ * information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
89
+ * </p>
90
+ *
91
+ * @throws {@link InternalServerError} (server fault)
92
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
93
+ *
94
+ * @throws {@link InvalidImageFormatException} (client fault)
95
+ * <p>The provided image format is not supported. </p>
96
+ *
97
+ * @throws {@link InvalidParameterException} (client fault)
98
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
99
+ * operation again.</p>
100
+ *
101
+ * @throws {@link InvalidS3ObjectException} (client fault)
102
+ * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
103
+ *
104
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
105
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
106
+ * limit, contact Amazon Rekognition.</p>
107
+ *
108
+ * @throws {@link ThrottlingException} (server fault)
109
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
110
+ *
111
+ *
112
+ * @example To compare two images
113
+ * ```javascript
114
+ * // This operation compares the largest face detected in the source image with each face detected in the target image.
115
+ * const input = {
116
+ * "SimilarityThreshold": 90,
117
+ * "SourceImage": {
118
+ * "S3Object": {
119
+ * "Bucket": "mybucket",
120
+ * "Name": "mysourceimage"
121
+ * }
122
+ * },
123
+ * "TargetImage": {
124
+ * "S3Object": {
125
+ * "Bucket": "mybucket",
126
+ * "Name": "mytargetimage"
127
+ * }
128
+ * }
129
+ * };
130
+ * const command = new CompareFacesCommand(input);
131
+ * const response = await client.send(command);
132
+ * /* response ==
133
+ * {
134
+ * "FaceMatches": [
135
+ * {
136
+ * "Face": {
137
+ * "BoundingBox": {
138
+ * "Height": 0.33481481671333313,
139
+ * "Left": 0.31888890266418457,
140
+ * "Top": 0.4933333396911621,
141
+ * "Width": 0.25
142
+ * },
143
+ * "Confidence": 99.9991226196289
144
+ * },
145
+ * "Similarity": 100
146
+ * }
147
+ * ],
148
+ * "SourceImageFace": {
149
+ * "BoundingBox": {
150
+ * "Height": 0.33481481671333313,
151
+ * "Left": 0.31888890266418457,
152
+ * "Top": 0.4933333396911621,
153
+ * "Width": 0.25
154
+ * },
155
+ * "Confidence": 99.9991226196289
156
+ * }
157
+ * }
158
+ * *\/
159
+ * // example id: to-compare-two-images-1482181985581
160
+ * ```
161
+ *
82
162
  */
83
163
  export declare class CompareFacesCommand extends $Command<CompareFacesCommandInput, CompareFacesCommandOutput, RekognitionClientResolvedConfig> {
84
164
  readonly input: CompareFacesCommandInput;
@@ -47,6 +47,67 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
47
47
  * @see {@link CopyProjectVersionCommandOutput} 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 InvalidParameterException} (client fault)
57
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
58
+ * operation again.</p>
59
+ *
60
+ * @throws {@link LimitExceededException} (client fault)
61
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
62
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
63
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
64
+ *
65
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
66
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
67
+ * limit, contact Amazon Rekognition.</p>
68
+ *
69
+ * @throws {@link ResourceInUseException} (client fault)
70
+ * <p>The specified resource is already being used.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>The resource specified in the request cannot be found.</p>
74
+ *
75
+ * @throws {@link ServiceQuotaExceededException} (client fault)
76
+ * <p></p>
77
+ * <p>The size of the collection exceeds the allowed limit. For more information,
78
+ * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
79
+ *
80
+ * @throws {@link ThrottlingException} (server fault)
81
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
82
+ *
83
+ *
84
+ * @example CopyProjectVersion
85
+ * ```javascript
86
+ * // This operation copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
87
+ * const input = {
88
+ * "DestinationProjectArn": "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765",
89
+ * "KmsKeyId": "arn:1234abcd-12ab-34cd-56ef-1234567890ab",
90
+ * "OutputConfig": {
91
+ * "S3Bucket": "bucket-name",
92
+ * "S3KeyPrefix": "path_to_folder"
93
+ * },
94
+ * "SourceProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456",
95
+ * "SourceProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456",
96
+ * "Tags": {
97
+ * "key1": "val1"
98
+ * },
99
+ * "VersionName": "DestinationVersionName_cross_account"
100
+ * };
101
+ * const command = new CopyProjectVersionCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "ProjectVersionArn": "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651"
106
+ * }
107
+ * *\/
108
+ * // example id: copyprojectversion-1658203943815
109
+ * ```
110
+ *
50
111
  */
51
112
  export declare class CopyProjectVersionCommand extends $Command<CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
52
113
  readonly input: CopyProjectVersionCommandInput;
@@ -43,6 +43,49 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
43
43
  * @see {@link CreateCollectionCommandOutput} for command's `response` shape.
44
44
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
45
45
  *
46
+ * @throws {@link AccessDeniedException} (client fault)
47
+ * <p>You are not authorized to perform the action.</p>
48
+ *
49
+ * @throws {@link InternalServerError} (server fault)
50
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
51
+ *
52
+ * @throws {@link InvalidParameterException} (client fault)
53
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
54
+ * operation again.</p>
55
+ *
56
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
57
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
58
+ * limit, contact Amazon Rekognition.</p>
59
+ *
60
+ * @throws {@link ResourceAlreadyExistsException} (client fault)
61
+ * <p>A resource with the specified ID already exists.</p>
62
+ *
63
+ * @throws {@link ServiceQuotaExceededException} (client fault)
64
+ * <p></p>
65
+ * <p>The size of the collection exceeds the allowed limit. For more information,
66
+ * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
67
+ *
68
+ * @throws {@link ThrottlingException} (server fault)
69
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
70
+ *
71
+ *
72
+ * @example To create a collection
73
+ * ```javascript
74
+ * // This operation creates a Rekognition collection for storing image data.
75
+ * const input = {
76
+ * "CollectionId": "myphotos"
77
+ * };
78
+ * const command = new CreateCollectionCommand(input);
79
+ * const response = await client.send(command);
80
+ * /* response ==
81
+ * {
82
+ * "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/myphotos",
83
+ * "StatusCode": 200
84
+ * }
85
+ * *\/
86
+ * // example id: to-create-a-collection-1481833313674
87
+ * ```
88
+ *
46
89
  */
47
90
  export declare class CreateCollectionCommand extends $Command<CreateCollectionCommandInput, CreateCollectionCommandOutput, RekognitionClientResolvedConfig> {
48
91
  readonly input: CreateCollectionCommandInput;
@@ -47,6 +47,38 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
47
47
  * @see {@link CreateDatasetCommandOutput} 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 InvalidParameterException} (client fault)
57
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
58
+ * operation again.</p>
59
+ *
60
+ * @throws {@link InvalidS3ObjectException} (client fault)
61
+ * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
62
+ *
63
+ * @throws {@link LimitExceededException} (client fault)
64
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
65
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
66
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
67
+ *
68
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
69
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
70
+ * limit, contact Amazon Rekognition.</p>
71
+ *
72
+ * @throws {@link ResourceAlreadyExistsException} (client fault)
73
+ * <p>A resource with the specified ID already exists.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The resource specified in the request cannot be found.</p>
77
+ *
78
+ * @throws {@link ThrottlingException} (server fault)
79
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
80
+ *
81
+ *
50
82
  */
51
83
  export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, RekognitionClientResolvedConfig> {
52
84
  readonly input: CreateDatasetCommandInput;
@@ -31,6 +31,32 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
31
31
  * @see {@link CreateProjectCommandOutput} for command's `response` shape.
32
32
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
33
33
  *
34
+ * @throws {@link AccessDeniedException} (client fault)
35
+ * <p>You are not authorized to perform the action.</p>
36
+ *
37
+ * @throws {@link InternalServerError} (server fault)
38
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
39
+ *
40
+ * @throws {@link InvalidParameterException} (client fault)
41
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
42
+ * operation again.</p>
43
+ *
44
+ * @throws {@link LimitExceededException} (client fault)
45
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
46
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
47
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
48
+ *
49
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
50
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
51
+ * limit, contact Amazon Rekognition.</p>
52
+ *
53
+ * @throws {@link ResourceInUseException} (client fault)
54
+ * <p>The specified resource is already being used.</p>
55
+ *
56
+ * @throws {@link ThrottlingException} (server fault)
57
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
58
+ *
59
+ *
34
60
  */
35
61
  export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, RekognitionClientResolvedConfig> {
36
62
  readonly input: CreateProjectCommandInput;
@@ -58,6 +58,40 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
58
58
  * @see {@link CreateProjectVersionCommandOutput} for command's `response` shape.
59
59
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
60
60
  *
61
+ * @throws {@link AccessDeniedException} (client fault)
62
+ * <p>You are not authorized to perform the action.</p>
63
+ *
64
+ * @throws {@link InternalServerError} (server fault)
65
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
66
+ *
67
+ * @throws {@link InvalidParameterException} (client fault)
68
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
69
+ * operation again.</p>
70
+ *
71
+ * @throws {@link LimitExceededException} (client fault)
72
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
73
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
74
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
75
+ *
76
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
77
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
78
+ * limit, contact Amazon Rekognition.</p>
79
+ *
80
+ * @throws {@link ResourceInUseException} (client fault)
81
+ * <p>The specified resource is already being used.</p>
82
+ *
83
+ * @throws {@link ResourceNotFoundException} (client fault)
84
+ * <p>The resource specified in the request cannot be found.</p>
85
+ *
86
+ * @throws {@link ServiceQuotaExceededException} (client fault)
87
+ * <p></p>
88
+ * <p>The size of the collection exceeds the allowed limit. For more information,
89
+ * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
90
+ *
91
+ * @throws {@link ThrottlingException} (server fault)
92
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
93
+ *
94
+ *
61
95
  */
62
96
  export declare class CreateProjectVersionCommand extends $Command<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
63
97
  readonly input: CreateProjectVersionCommandInput;
@@ -49,6 +49,37 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
49
49
  * @see {@link CreateStreamProcessorCommandOutput} for command's `response` shape.
50
50
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
51
51
  *
52
+ * @throws {@link AccessDeniedException} (client fault)
53
+ * <p>You are not authorized to perform the action.</p>
54
+ *
55
+ * @throws {@link InternalServerError} (server fault)
56
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
57
+ *
58
+ * @throws {@link InvalidParameterException} (client fault)
59
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
60
+ * operation again.</p>
61
+ *
62
+ * @throws {@link LimitExceededException} (client fault)
63
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
64
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
65
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
66
+ *
67
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
68
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
69
+ * limit, contact Amazon Rekognition.</p>
70
+ *
71
+ * @throws {@link ResourceInUseException} (client fault)
72
+ * <p>The specified resource is already being used.</p>
73
+ *
74
+ * @throws {@link ServiceQuotaExceededException} (client fault)
75
+ * <p></p>
76
+ * <p>The size of the collection exceeds the allowed limit. For more information,
77
+ * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
78
+ *
79
+ * @throws {@link ThrottlingException} (server fault)
80
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
81
+ *
82
+ *
52
83
  */
53
84
  export declare class CreateStreamProcessorCommand extends $Command<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
54
85
  readonly input: CreateStreamProcessorCommandInput;
@@ -33,6 +33,43 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
33
33
  * @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
34
34
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
35
35
  *
36
+ * @throws {@link AccessDeniedException} (client fault)
37
+ * <p>You are not authorized to perform the action.</p>
38
+ *
39
+ * @throws {@link InternalServerError} (server fault)
40
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</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 To delete a collection
58
+ * ```javascript
59
+ * // This operation deletes a Rekognition collection.
60
+ * const input = {
61
+ * "CollectionId": "myphotos"
62
+ * };
63
+ * const command = new DeleteCollectionCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "StatusCode": 200
68
+ * }
69
+ * *\/
70
+ * // example id: to-delete-a-collection-1481838179973
71
+ * ```
72
+ *
36
73
  */
37
74
  export declare class DeleteCollectionCommand extends $Command<DeleteCollectionCommandInput, DeleteCollectionCommandOutput, RekognitionClientResolvedConfig> {
38
75
  readonly input: DeleteCollectionCommandInput;
@@ -38,6 +38,35 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
38
38
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
39
39
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
40
40
  *
41
+ * @throws {@link AccessDeniedException} (client fault)
42
+ * <p>You are not authorized to perform the action.</p>
43
+ *
44
+ * @throws {@link InternalServerError} (server fault)
45
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</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 LimitExceededException} (client fault)
52
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
53
+ * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
54
+ * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
55
+ *
56
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
57
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
58
+ * limit, contact Amazon Rekognition.</p>
59
+ *
60
+ * @throws {@link ResourceInUseException} (client fault)
61
+ * <p>The specified resource is already being used.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The resource specified in the request cannot be found.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (server fault)
67
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
68
+ *
69
+ *
41
70
  */
42
71
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, RekognitionClientResolvedConfig> {
43
72
  readonly input: DeleteDatasetCommandInput;
@@ -32,6 +32,48 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
32
32
  * @see {@link DeleteFacesCommandOutput} for command's `response` shape.
33
33
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
34
34
  *
35
+ * @throws {@link AccessDeniedException} (client fault)
36
+ * <p>You are not authorized to perform the action.</p>
37
+ *
38
+ * @throws {@link InternalServerError} (server fault)
39
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
40
+ *
41
+ * @throws {@link InvalidParameterException} (client fault)
42
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
43
+ * operation again.</p>
44
+ *
45
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
46
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
47
+ * limit, contact Amazon Rekognition.</p>
48
+ *
49
+ * @throws {@link ResourceNotFoundException} (client fault)
50
+ * <p>The resource specified in the request cannot be found.</p>
51
+ *
52
+ * @throws {@link ThrottlingException} (server fault)
53
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
54
+ *
55
+ *
56
+ * @example To delete a face
57
+ * ```javascript
58
+ * // This operation deletes one or more faces from a Rekognition collection.
59
+ * const input = {
60
+ * "CollectionId": "myphotos",
61
+ * "FaceIds": [
62
+ * "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
63
+ * ]
64
+ * };
65
+ * const command = new DeleteFacesCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "DeletedFaces": [
70
+ * "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
71
+ * ]
72
+ * }
73
+ * *\/
74
+ * // example id: to-delete-a-face-1482182799377
75
+ * ```
76
+ *
35
77
  */
36
78
  export declare class DeleteFacesCommand extends $Command<DeleteFacesCommandInput, DeleteFacesCommandOutput, RekognitionClientResolvedConfig> {
37
79
  readonly input: DeleteFacesCommandInput;
@@ -37,6 +37,30 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
37
37
  * @see {@link DeleteProjectCommandOutput} for command's `response` shape.
38
38
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
39
39
  *
40
+ * @throws {@link AccessDeniedException} (client fault)
41
+ * <p>You are not authorized to perform the action.</p>
42
+ *
43
+ * @throws {@link InternalServerError} (server fault)
44
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</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 ThrottlingException} (server fault)
61
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
62
+ *
63
+ *
40
64
  */
41
65
  export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, RekognitionClientResolvedConfig> {
42
66
  readonly input: DeleteProjectCommandInput;
@@ -30,6 +30,43 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
30
30
  * @see {@link DeleteProjectPolicyCommandOutput} 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 InvalidParameterException} (client fault)
40
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
41
+ * operation again.</p>
42
+ *
43
+ * @throws {@link InvalidPolicyRevisionIdException} (client fault)
44
+ * <p>The supplied revision id for the project policy is invalid.</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 DeleteProjectPolicy
58
+ * ```javascript
59
+ * // This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project.
60
+ * const input = {
61
+ * "PolicyName": "testPolicy1",
62
+ * "PolicyRevisionId": "3b274c25e9203a56a99e00e3ff205fbc",
63
+ * "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456"
64
+ * };
65
+ * const command = new DeleteProjectPolicyCommand(input);
66
+ * await client.send(command);
67
+ * // example id: deleteprojectpolicy-1658204413810
68
+ * ```
69
+ *
33
70
  */
34
71
  export declare class DeleteProjectPolicyCommand extends $Command<DeleteProjectPolicyCommandInput, DeleteProjectPolicyCommandOutput, RekognitionClientResolvedConfig> {
35
72
  readonly input: DeleteProjectPolicyCommandInput;
@@ -36,6 +36,30 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
36
36
  * @see {@link DeleteProjectVersionCommandOutput} for command's `response` shape.
37
37
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
38
38
  *
39
+ * @throws {@link AccessDeniedException} (client fault)
40
+ * <p>You are not authorized to perform the action.</p>
41
+ *
42
+ * @throws {@link InternalServerError} (server fault)
43
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
44
+ *
45
+ * @throws {@link InvalidParameterException} (client fault)
46
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
47
+ * operation again.</p>
48
+ *
49
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
50
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
51
+ * limit, contact Amazon Rekognition.</p>
52
+ *
53
+ * @throws {@link ResourceInUseException} (client fault)
54
+ * <p>The specified resource is already being used.</p>
55
+ *
56
+ * @throws {@link ResourceNotFoundException} (client fault)
57
+ * <p>The resource specified in the request cannot be found.</p>
58
+ *
59
+ * @throws {@link ThrottlingException} (server fault)
60
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
61
+ *
62
+ *
39
63
  */
40
64
  export declare class DeleteProjectVersionCommand extends $Command<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
41
65
  readonly input: DeleteProjectVersionCommandInput;
@@ -30,6 +30,30 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso
30
30
  * @see {@link DeleteStreamProcessorCommandOutput} 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 InvalidParameterException} (client fault)
40
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
41
+ * operation again.</p>
42
+ *
43
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
44
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
45
+ * limit, contact Amazon Rekognition.</p>
46
+ *
47
+ * @throws {@link ResourceInUseException} (client fault)
48
+ * <p>The specified resource is already being used.</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
+ *
33
57
  */
34
58
  export declare class DeleteStreamProcessorCommand extends $Command<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
35
59
  readonly input: DeleteStreamProcessorCommandInput;
@@ -33,6 +33,27 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo
33
33
  * @see {@link DescribeCollectionCommandOutput} for command's `response` shape.
34
34
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
35
35
  *
36
+ * @throws {@link AccessDeniedException} (client fault)
37
+ * <p>You are not authorized to perform the action.</p>
38
+ *
39
+ * @throws {@link InternalServerError} (server fault)
40
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</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
+ *
36
57
  */
37
58
  export declare class DescribeCollectionCommand extends $Command<DescribeCollectionCommandInput, DescribeCollectionCommandOutput, RekognitionClientResolvedConfig> {
38
59
  readonly input: DescribeCollectionCommandInput;