@aws-sdk/client-rekognition 3.36.0 → 3.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +42 -0
- package/dist-cjs/Rekognition.js +0 -3
- package/dist-cjs/RekognitionClient.js +0 -8
- package/dist-cjs/commands/CompareFacesCommand.js +0 -86
- package/dist-cjs/commands/CreateCollectionCommand.js +0 -36
- package/dist-cjs/commands/CreateProjectCommand.js +0 -26
- package/dist-cjs/commands/CreateProjectVersionCommand.js +0 -35
- package/dist-cjs/commands/CreateStreamProcessorCommand.js +0 -34
- package/dist-cjs/commands/DeleteCollectionCommand.js +0 -28
- package/dist-cjs/commands/DeleteFacesCommand.js +0 -27
- package/dist-cjs/commands/DeleteProjectCommand.js +0 -27
- package/dist-cjs/commands/DeleteProjectVersionCommand.js +0 -31
- package/dist-cjs/commands/DeleteStreamProcessorCommand.js +0 -25
- package/dist-cjs/commands/DescribeCollectionCommand.js +0 -29
- package/dist-cjs/commands/DescribeProjectVersionsCommand.js +0 -28
- package/dist-cjs/commands/DescribeProjectsCommand.js +0 -25
- package/dist-cjs/commands/DescribeStreamProcessorCommand.js +0 -25
- package/dist-cjs/commands/DetectCustomLabelsCommand.js +0 -74
- package/dist-cjs/commands/DetectFacesCommand.js +0 -46
- package/dist-cjs/commands/DetectLabelsCommand.js +0 -96
- package/dist-cjs/commands/DetectModerationLabelsCommand.js +0 -37
- package/dist-cjs/commands/DetectProtectiveEquipmentCommand.js +0 -63
- package/dist-cjs/commands/DetectTextCommand.js +0 -45
- package/dist-cjs/commands/GetCelebrityInfoCommand.js +0 -31
- package/dist-cjs/commands/GetCelebrityRecognitionCommand.js +0 -58
- package/dist-cjs/commands/GetContentModerationCommand.js +0 -53
- package/dist-cjs/commands/GetFaceDetectionCommand.js +0 -36
- package/dist-cjs/commands/GetFaceSearchCommand.js +0 -54
- package/dist-cjs/commands/GetLabelDetectionCommand.js +0 -44
- package/dist-cjs/commands/GetPersonTrackingCommand.js +0 -53
- package/dist-cjs/commands/GetSegmentDetectionCommand.js +0 -46
- package/dist-cjs/commands/GetTextDetectionCommand.js +0 -42
- package/dist-cjs/commands/IndexFacesCommand.js +0 -123
- package/dist-cjs/commands/ListCollectionsCommand.js +0 -29
- package/dist-cjs/commands/ListFacesCommand.js +0 -31
- package/dist-cjs/commands/ListStreamProcessorsCommand.js +0 -24
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -28
- package/dist-cjs/commands/RecognizeCelebritiesCommand.js +0 -54
- package/dist-cjs/commands/SearchFacesByImageCommand.js +0 -70
- package/dist-cjs/commands/SearchFacesCommand.js +0 -44
- package/dist-cjs/commands/StartCelebrityRecognitionCommand.js +0 -35
- package/dist-cjs/commands/StartContentModerationCommand.js +0 -35
- package/dist-cjs/commands/StartFaceDetectionCommand.js +0 -36
- package/dist-cjs/commands/StartFaceSearchCommand.js +0 -33
- package/dist-cjs/commands/StartLabelDetectionCommand.js +0 -38
- package/dist-cjs/commands/StartPersonTrackingCommand.js +0 -32
- package/dist-cjs/commands/StartProjectVersionCommand.js +0 -33
- package/dist-cjs/commands/StartSegmentDetectionCommand.js +0 -39
- package/dist-cjs/commands/StartStreamProcessorCommand.js +0 -26
- package/dist-cjs/commands/StartTextDetectionCommand.js +0 -31
- package/dist-cjs/commands/StopProjectVersionCommand.js +0 -25
- package/dist-cjs/commands/StopStreamProcessorCommand.js +0 -24
- package/dist-cjs/commands/TagResourceCommand.js +0 -28
- package/dist-cjs/commands/UntagResourceCommand.js +0 -28
- package/dist-cjs/commands/index.js +54 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +5 -69
- package/dist-cjs/models/models_0.js +0 -621
- package/dist-cjs/pagination/DescribeProjectVersionsPaginator.js +0 -10
- package/dist-cjs/pagination/DescribeProjectsPaginator.js +0 -10
- package/dist-cjs/pagination/GetCelebrityRecognitionPaginator.js +0 -10
- package/dist-cjs/pagination/GetContentModerationPaginator.js +0 -10
- package/dist-cjs/pagination/GetFaceDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetFaceSearchPaginator.js +0 -10
- package/dist-cjs/pagination/GetLabelDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetPersonTrackingPaginator.js +0 -10
- package/dist-cjs/pagination/GetSegmentDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/GetTextDetectionPaginator.js +0 -10
- package/dist-cjs/pagination/ListCollectionsPaginator.js +0 -10
- package/dist-cjs/pagination/ListFacesPaginator.js +0 -10
- package/dist-cjs/pagination/ListStreamProcessorsPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +17 -0
- package/dist-cjs/protocols/Aws_json1_1.js +0 -5
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-cjs/waiters/index.js +5 -0
- package/dist-cjs/waiters/waitForProjectVersionRunning.js +0 -9
- package/dist-cjs/waiters/waitForProjectVersionTrainingCompleted.js +0 -9
- package/dist-es/commands/index.js +51 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +5 -69
- package/dist-es/pagination/index.js +14 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-types/commands/index.d.ts +51 -0
- package/dist-types/index.d.ts +5 -69
- package/dist-types/pagination/index.d.ts +14 -0
- package/dist-types/ts3.4/Rekognition.d.ts +52 -1018
- package/dist-types/ts3.4/RekognitionClient.d.ts +24 -89
- package/dist-types/ts3.4/commands/CompareFacesCommand.d.ts +2 -82
- package/dist-types/ts3.4/commands/CreateCollectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/CreateProjectCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/CreateProjectVersionCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/CreateStreamProcessorCommand.d.ts +2 -30
- package/dist-types/ts3.4/commands/DeleteCollectionCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DeleteFacesCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteProjectCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteProjectVersionCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/DeleteStreamProcessorCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DescribeCollectionCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/DescribeProjectVersionsCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DescribeProjectsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DescribeStreamProcessorCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DetectCustomLabelsCommand.d.ts +2 -70
- package/dist-types/ts3.4/commands/DetectFacesCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/DetectLabelsCommand.d.ts +2 -92
- package/dist-types/ts3.4/commands/DetectModerationLabelsCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/DetectProtectiveEquipmentCommand.d.ts +2 -59
- package/dist-types/ts3.4/commands/DetectTextCommand.d.ts +2 -41
- package/dist-types/ts3.4/commands/GetCelebrityInfoCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/GetCelebrityRecognitionCommand.d.ts +2 -54
- package/dist-types/ts3.4/commands/GetContentModerationCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/GetFaceDetectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/GetFaceSearchCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/GetLabelDetectionCommand.d.ts +2 -40
- package/dist-types/ts3.4/commands/GetPersonTrackingCommand.d.ts +2 -49
- package/dist-types/ts3.4/commands/GetSegmentDetectionCommand.d.ts +2 -42
- package/dist-types/ts3.4/commands/GetTextDetectionCommand.d.ts +2 -38
- package/dist-types/ts3.4/commands/IndexFacesCommand.d.ts +2 -119
- package/dist-types/ts3.4/commands/ListCollectionsCommand.d.ts +2 -25
- package/dist-types/ts3.4/commands/ListFacesCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/ListStreamProcessorsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/RecognizeCelebritiesCommand.d.ts +2 -50
- package/dist-types/ts3.4/commands/SearchFacesByImageCommand.d.ts +2 -66
- package/dist-types/ts3.4/commands/SearchFacesCommand.d.ts +2 -40
- package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/StartContentModerationCommand.d.ts +2 -31
- package/dist-types/ts3.4/commands/StartFaceDetectionCommand.d.ts +2 -32
- package/dist-types/ts3.4/commands/StartFaceSearchCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/StartLabelDetectionCommand.d.ts +2 -34
- package/dist-types/ts3.4/commands/StartPersonTrackingCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/StartProjectVersionCommand.d.ts +2 -29
- package/dist-types/ts3.4/commands/StartSegmentDetectionCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/StartStreamProcessorCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/StartTextDetectionCommand.d.ts +2 -27
- package/dist-types/ts3.4/commands/StopProjectVersionCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/StopStreamProcessorCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/index.d.ts +51 -0
- package/dist-types/ts3.4/index.d.ts +5 -69
- package/dist-types/ts3.4/models/models_0.d.ts +856 -3431
- package/dist-types/ts3.4/pagination/index.d.ts +14 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForProjectVersionRunning.d.ts +2 -9
- package/dist-types/ts3.4/waiters/waitForProjectVersionTrainingCompleted.d.ts +2 -9
- package/dist-types/waiters/index.d.ts +2 -0
- package/package.json +33 -33
|
@@ -60,124 +60,59 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
60
60
|
export declare type ServiceInputTypes = CompareFacesCommandInput | CreateCollectionCommandInput | CreateProjectCommandInput | CreateProjectVersionCommandInput | CreateStreamProcessorCommandInput | DeleteCollectionCommandInput | DeleteFacesCommandInput | DeleteProjectCommandInput | DeleteProjectVersionCommandInput | DeleteStreamProcessorCommandInput | DescribeCollectionCommandInput | DescribeProjectVersionsCommandInput | DescribeProjectsCommandInput | DescribeStreamProcessorCommandInput | DetectCustomLabelsCommandInput | DetectFacesCommandInput | DetectLabelsCommandInput | DetectModerationLabelsCommandInput | DetectProtectiveEquipmentCommandInput | DetectTextCommandInput | GetCelebrityInfoCommandInput | GetCelebrityRecognitionCommandInput | GetContentModerationCommandInput | GetFaceDetectionCommandInput | GetFaceSearchCommandInput | GetLabelDetectionCommandInput | GetPersonTrackingCommandInput | GetSegmentDetectionCommandInput | GetTextDetectionCommandInput | IndexFacesCommandInput | ListCollectionsCommandInput | ListFacesCommandInput | ListStreamProcessorsCommandInput | ListTagsForResourceCommandInput | RecognizeCelebritiesCommandInput | SearchFacesByImageCommandInput | SearchFacesCommandInput | StartCelebrityRecognitionCommandInput | StartContentModerationCommandInput | StartFaceDetectionCommandInput | StartFaceSearchCommandInput | StartLabelDetectionCommandInput | StartPersonTrackingCommandInput | StartProjectVersionCommandInput | StartSegmentDetectionCommandInput | StartStreamProcessorCommandInput | StartTextDetectionCommandInput | StopProjectVersionCommandInput | StopStreamProcessorCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
|
|
61
61
|
export declare type ServiceOutputTypes = CompareFacesCommandOutput | CreateCollectionCommandOutput | CreateProjectCommandOutput | CreateProjectVersionCommandOutput | CreateStreamProcessorCommandOutput | DeleteCollectionCommandOutput | DeleteFacesCommandOutput | DeleteProjectCommandOutput | DeleteProjectVersionCommandOutput | DeleteStreamProcessorCommandOutput | DescribeCollectionCommandOutput | DescribeProjectVersionsCommandOutput | DescribeProjectsCommandOutput | DescribeStreamProcessorCommandOutput | DetectCustomLabelsCommandOutput | DetectFacesCommandOutput | DetectLabelsCommandOutput | DetectModerationLabelsCommandOutput | DetectProtectiveEquipmentCommandOutput | DetectTextCommandOutput | GetCelebrityInfoCommandOutput | GetCelebrityRecognitionCommandOutput | GetContentModerationCommandOutput | GetFaceDetectionCommandOutput | GetFaceSearchCommandOutput | GetLabelDetectionCommandOutput | GetPersonTrackingCommandOutput | GetSegmentDetectionCommandOutput | GetTextDetectionCommandOutput | IndexFacesCommandOutput | ListCollectionsCommandOutput | ListFacesCommandOutput | ListStreamProcessorsCommandOutput | ListTagsForResourceCommandOutput | RecognizeCelebritiesCommandOutput | SearchFacesByImageCommandOutput | SearchFacesCommandOutput | StartCelebrityRecognitionCommandOutput | StartContentModerationCommandOutput | StartFaceDetectionCommandOutput | StartFaceSearchCommandOutput | StartLabelDetectionCommandOutput | StartPersonTrackingCommandOutput | StartProjectVersionCommandOutput | StartSegmentDetectionCommandOutput | StartStreamProcessorCommandOutput | StartTextDetectionCommandOutput | StopProjectVersionCommandOutput | StopStreamProcessorCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
|
|
62
62
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
63
|
-
|
|
64
|
-
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
65
|
-
*/
|
|
63
|
+
|
|
66
64
|
requestHandler?: __HttpHandler;
|
|
67
|
-
|
|
68
|
-
* A constructor for a class implementing the {@link __Hash} interface
|
|
69
|
-
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
70
|
-
* @internal
|
|
71
|
-
*/
|
|
65
|
+
|
|
72
66
|
sha256?: __HashConstructor;
|
|
73
|
-
|
|
74
|
-
* The function that will be used to convert strings into HTTP endpoints.
|
|
75
|
-
* @internal
|
|
76
|
-
*/
|
|
67
|
+
|
|
77
68
|
urlParser?: __UrlParser;
|
|
78
|
-
|
|
79
|
-
* A function that can calculate the length of a request body.
|
|
80
|
-
* @internal
|
|
81
|
-
*/
|
|
69
|
+
|
|
82
70
|
bodyLengthChecker?: (body: any) => number | undefined;
|
|
83
|
-
|
|
84
|
-
* A function that converts a stream into an array of bytes.
|
|
85
|
-
* @internal
|
|
86
|
-
*/
|
|
71
|
+
|
|
87
72
|
streamCollector?: __StreamCollector;
|
|
88
|
-
|
|
89
|
-
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
90
|
-
* @internal
|
|
91
|
-
*/
|
|
73
|
+
|
|
92
74
|
base64Decoder?: __Decoder;
|
|
93
|
-
|
|
94
|
-
* The function that will be used to convert binary data to a base64-encoded string.
|
|
95
|
-
* @internal
|
|
96
|
-
*/
|
|
75
|
+
|
|
97
76
|
base64Encoder?: __Encoder;
|
|
98
|
-
|
|
99
|
-
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
100
|
-
* @internal
|
|
101
|
-
*/
|
|
77
|
+
|
|
102
78
|
utf8Decoder?: __Decoder;
|
|
103
|
-
|
|
104
|
-
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
105
|
-
* @internal
|
|
106
|
-
*/
|
|
79
|
+
|
|
107
80
|
utf8Encoder?: __Encoder;
|
|
108
|
-
|
|
109
|
-
* The runtime environment.
|
|
110
|
-
* @internal
|
|
111
|
-
*/
|
|
81
|
+
|
|
112
82
|
runtime?: string;
|
|
113
|
-
|
|
114
|
-
* Disable dyanamically changing the endpoint of the client based on the hostPrefix
|
|
115
|
-
* trait of an operation.
|
|
116
|
-
*/
|
|
83
|
+
|
|
117
84
|
disableHostPrefix?: boolean;
|
|
118
|
-
|
|
119
|
-
* Value for how many times a request will be made at most in case of retry.
|
|
120
|
-
*/
|
|
85
|
+
|
|
121
86
|
maxAttempts?: number | __Provider<number>;
|
|
122
|
-
|
|
123
|
-
* Specifies which retry algorithm to use.
|
|
124
|
-
*/
|
|
87
|
+
|
|
125
88
|
retryMode?: string | __Provider<string>;
|
|
126
|
-
|
|
127
|
-
* Optional logger for logging debug/info/warn/error.
|
|
128
|
-
*/
|
|
89
|
+
|
|
129
90
|
logger?: __Logger;
|
|
130
|
-
|
|
131
|
-
* Unique service identifier.
|
|
132
|
-
* @internal
|
|
133
|
-
*/
|
|
91
|
+
|
|
134
92
|
serviceId?: string;
|
|
135
|
-
|
|
136
|
-
* The AWS region to which this client will send requests
|
|
137
|
-
*/
|
|
93
|
+
|
|
138
94
|
region?: string | __Provider<string>;
|
|
139
|
-
|
|
140
|
-
* Default credentials provider; Not available in browser runtime.
|
|
141
|
-
* @internal
|
|
142
|
-
*/
|
|
95
|
+
|
|
143
96
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
144
|
-
|
|
145
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
146
|
-
* @internal
|
|
147
|
-
*/
|
|
97
|
+
|
|
148
98
|
regionInfoProvider?: RegionInfoProvider;
|
|
149
|
-
|
|
150
|
-
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
151
|
-
* @internal
|
|
152
|
-
*/
|
|
99
|
+
|
|
153
100
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
154
101
|
}
|
|
155
102
|
declare type RekognitionClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
156
|
-
|
|
157
|
-
* The configuration interface of RekognitionClient class constructor that set the region, credentials and other options.
|
|
158
|
-
*/
|
|
103
|
+
|
|
159
104
|
export interface RekognitionClientConfig extends RekognitionClientConfigType {
|
|
160
105
|
}
|
|
161
106
|
declare type RekognitionClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
|
|
162
|
-
|
|
163
|
-
* The resolved configuration interface of RekognitionClient class. This is resolved and normalized from the {@link RekognitionClientConfig | constructor configuration interface}.
|
|
164
|
-
*/
|
|
107
|
+
|
|
165
108
|
export interface RekognitionClientResolvedConfig extends RekognitionClientResolvedConfigType {
|
|
166
109
|
}
|
|
167
|
-
|
|
168
|
-
* <p>This is the Amazon Rekognition API reference.</p>
|
|
169
|
-
*/
|
|
110
|
+
|
|
170
111
|
export declare class RekognitionClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RekognitionClientResolvedConfig> {
|
|
171
|
-
|
|
172
|
-
* The resolved configuration of RekognitionClient class. This is resolved and normalized from the {@link RekognitionClientConfig | constructor configuration interface}.
|
|
173
|
-
*/
|
|
112
|
+
|
|
174
113
|
readonly config: RekognitionClientResolvedConfig;
|
|
175
114
|
constructor(configuration: RekognitionClientConfig);
|
|
176
|
-
|
|
177
|
-
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
178
|
-
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
179
|
-
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
180
|
-
*/
|
|
115
|
+
|
|
181
116
|
destroy(): void;
|
|
182
117
|
}
|
|
183
118
|
export {};
|
|
@@ -6,91 +6,11 @@ export interface CompareFacesCommandInput extends CompareFacesRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CompareFacesCommandOutput extends CompareFacesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Compares a face in the <i>source</i> input image with
|
|
11
|
-
* each of the 100 largest faces detected in the <i>target</i> input image.
|
|
12
|
-
* </p>
|
|
13
|
-
*
|
|
14
|
-
* <p> If the source image contains multiple faces, the service detects the largest face
|
|
15
|
-
* and compares it with each face detected in the target image. </p>
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <note>
|
|
19
|
-
* <p>CompareFaces uses machine learning algorithms, which are probabilistic.
|
|
20
|
-
* A false negative is an incorrect prediction that
|
|
21
|
-
* a face in the target image has a low similarity confidence score when compared to the face
|
|
22
|
-
* in the source image. To reduce the probability of false negatives,
|
|
23
|
-
* we recommend that you compare the target image against multiple source images.
|
|
24
|
-
* If you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's rights,
|
|
25
|
-
* privacy, or access to services, we recommend that you pass the result to a human for review and further
|
|
26
|
-
* validation before taking action.</p>
|
|
27
|
-
* </note>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <p>You pass the input and target images either as base64-encoded image bytes or as
|
|
31
|
-
* references to images in an Amazon S3 bucket. If you use the
|
|
32
|
-
* AWS
|
|
33
|
-
* CLI to call Amazon Rekognition operations, passing image bytes isn't
|
|
34
|
-
* supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
35
|
-
* <p>In response, the operation returns an array of face matches ordered by similarity score
|
|
36
|
-
* in descending order. For each face match, the response provides a bounding box of the face,
|
|
37
|
-
* facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and
|
|
38
|
-
* confidence value (indicating the level of confidence that the bounding box contains a face).
|
|
39
|
-
* The response also provides a similarity score, which indicates how closely the faces match. </p>
|
|
40
|
-
*
|
|
41
|
-
* <note>
|
|
42
|
-
* <p>By default, only faces with a similarity score of greater than or equal to 80% are
|
|
43
|
-
* returned in the response. You can change this value by specifying the
|
|
44
|
-
* <code>SimilarityThreshold</code> parameter.</p>
|
|
45
|
-
* </note>
|
|
46
|
-
*
|
|
47
|
-
* <p>
|
|
48
|
-
* <code>CompareFaces</code> also returns an array of faces that don't match the source image.
|
|
49
|
-
* For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.
|
|
50
|
-
* The response also returns information about the face in the source image, including the bounding box
|
|
51
|
-
* of the face and confidence value.</p>
|
|
52
|
-
*
|
|
53
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
54
|
-
* that don’t meet a required quality bar. The quality bar is based on a
|
|
55
|
-
* variety of common use cases. Use <code>QualityFilter</code> to set the quality bar
|
|
56
|
-
* by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
|
|
57
|
-
* If you do not want to filter detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
|
|
58
|
-
*
|
|
59
|
-
* <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the
|
|
60
|
-
* source and target images. Use these values to display the images with the correct image orientation.</p>
|
|
61
|
-
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code> returns an
|
|
62
|
-
* <code>InvalidParameterException</code> error. </p>
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
* <note>
|
|
66
|
-
* <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p>
|
|
67
|
-
* </note>
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
* <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.</p>
|
|
71
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code>
|
|
72
|
-
* action.</p>
|
|
73
|
-
* @example
|
|
74
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
75
|
-
* ```javascript
|
|
76
|
-
* import { RekognitionClient, CompareFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
77
|
-
* // const { RekognitionClient, CompareFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
78
|
-
* const client = new RekognitionClient(config);
|
|
79
|
-
* const command = new CompareFacesCommand(input);
|
|
80
|
-
* const response = await client.send(command);
|
|
81
|
-
* ```
|
|
82
|
-
*
|
|
83
|
-
* @see {@link CompareFacesCommandInput} for command's `input` shape.
|
|
84
|
-
* @see {@link CompareFacesCommandOutput} for command's `response` shape.
|
|
85
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
86
|
-
*
|
|
87
|
-
*/
|
|
9
|
+
|
|
88
10
|
export declare class CompareFacesCommand extends $Command<CompareFacesCommandInput, CompareFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
89
11
|
readonly input: CompareFacesCommandInput;
|
|
90
12
|
constructor(input: CompareFacesCommandInput);
|
|
91
|
-
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
13
|
+
|
|
94
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompareFacesCommandInput, CompareFacesCommandOutput>;
|
|
95
15
|
private serialize;
|
|
96
16
|
private deserialize;
|
|
@@ -6,41 +6,11 @@ export interface CreateCollectionCommandInput extends CreateCollectionRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateCollectionCommandOutput extends CreateCollectionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a collection in an AWS Region. You can add faces to the collection using the
|
|
11
|
-
* <a>IndexFaces</a> operation. </p>
|
|
12
|
-
* <p>For example, you might create collections, one for each of your application users. A
|
|
13
|
-
* user can then index faces using the <code>IndexFaces</code> operation and persist results in a
|
|
14
|
-
* specific collection. Then, a user can search the collection for faces in the user-specific
|
|
15
|
-
* container. </p>
|
|
16
|
-
* <p>When you create a collection, it is associated with the latest version of the face model version.</p>
|
|
17
|
-
* <note>
|
|
18
|
-
* <p>Collection names are case-sensitive.</p>
|
|
19
|
-
* </note>
|
|
20
|
-
*
|
|
21
|
-
* <p>This operation requires permissions to perform the
|
|
22
|
-
* <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
|
|
23
|
-
* @example
|
|
24
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
-
* ```javascript
|
|
26
|
-
* import { RekognitionClient, CreateCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
27
|
-
* // const { RekognitionClient, CreateCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
28
|
-
* const client = new RekognitionClient(config);
|
|
29
|
-
* const command = new CreateCollectionCommand(input);
|
|
30
|
-
* const response = await client.send(command);
|
|
31
|
-
* ```
|
|
32
|
-
*
|
|
33
|
-
* @see {@link CreateCollectionCommandInput} for command's `input` shape.
|
|
34
|
-
* @see {@link CreateCollectionCommandOutput} for command's `response` shape.
|
|
35
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
9
|
+
|
|
38
10
|
export declare class CreateCollectionCommand extends $Command<CreateCollectionCommandInput, CreateCollectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
39
11
|
readonly input: CreateCollectionCommandInput;
|
|
40
12
|
constructor(input: CreateCollectionCommandInput);
|
|
41
|
-
|
|
42
|
-
* @internal
|
|
43
|
-
*/
|
|
13
|
+
|
|
44
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCollectionCommandInput, CreateCollectionCommandOutput>;
|
|
45
15
|
private serialize;
|
|
46
16
|
private deserialize;
|
|
@@ -6,31 +6,11 @@ export interface CreateProjectCommandInput extends CreateProjectRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateProjectCommandOutput extends CreateProjectResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models)
|
|
11
|
-
* and operations (training, evaluation and detection). </p>
|
|
12
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
|
|
13
|
-
* @example
|
|
14
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
-
* ```javascript
|
|
16
|
-
* import { RekognitionClient, CreateProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
17
|
-
* // const { RekognitionClient, CreateProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
18
|
-
* const client = new RekognitionClient(config);
|
|
19
|
-
* const command = new CreateProjectCommand(input);
|
|
20
|
-
* const response = await client.send(command);
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @see {@link CreateProjectCommandInput} for command's `input` shape.
|
|
24
|
-
* @see {@link CreateProjectCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
26
|
-
*
|
|
27
|
-
*/
|
|
9
|
+
|
|
28
10
|
export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, RekognitionClientResolvedConfig> {
|
|
29
11
|
readonly input: CreateProjectCommandInput;
|
|
30
12
|
constructor(input: CreateProjectCommandInput);
|
|
31
|
-
|
|
32
|
-
* @internal
|
|
33
|
-
*/
|
|
13
|
+
|
|
34
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProjectCommandInput, CreateProjectCommandOutput>;
|
|
35
15
|
private serialize;
|
|
36
16
|
private deserialize;
|
|
@@ -6,40 +6,11 @@ export interface CreateProjectVersionCommandInput extends CreateProjectVersionRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateProjectVersionCommandOutput extends CreateProjectVersionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates a new version of a model and begins training.
|
|
11
|
-
* Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify
|
|
12
|
-
* one training dataset and one testing dataset. The response from <code>CreateProjectVersion</code>
|
|
13
|
-
* is an Amazon Resource Name (ARN) for the version of the model. </p>
|
|
14
|
-
* <p>Training takes a while to complete. You can get the current status by calling
|
|
15
|
-
* <a>DescribeProjectVersions</a>.</p>
|
|
16
|
-
* <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
|
|
17
|
-
* get the training results and evaluate the model.
|
|
18
|
-
* </p>
|
|
19
|
-
* <p>After evaluating the model, you start the model
|
|
20
|
-
* by calling <a>StartProjectVersion</a>.</p>
|
|
21
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
|
|
22
|
-
* @example
|
|
23
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
24
|
-
* ```javascript
|
|
25
|
-
* import { RekognitionClient, CreateProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
26
|
-
* // const { RekognitionClient, CreateProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
27
|
-
* const client = new RekognitionClient(config);
|
|
28
|
-
* const command = new CreateProjectVersionCommand(input);
|
|
29
|
-
* const response = await client.send(command);
|
|
30
|
-
* ```
|
|
31
|
-
*
|
|
32
|
-
* @see {@link CreateProjectVersionCommandInput} for command's `input` shape.
|
|
33
|
-
* @see {@link CreateProjectVersionCommandOutput} for command's `response` shape.
|
|
34
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
9
|
+
|
|
37
10
|
export declare class CreateProjectVersionCommand extends $Command<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
|
|
38
11
|
readonly input: CreateProjectVersionCommandInput;
|
|
39
12
|
constructor(input: CreateProjectVersionCommandInput);
|
|
40
|
-
|
|
41
|
-
* @internal
|
|
42
|
-
*/
|
|
13
|
+
|
|
43
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput>;
|
|
44
15
|
private serialize;
|
|
45
16
|
private deserialize;
|
|
@@ -6,39 +6,11 @@ export interface CreateStreamProcessorCommandInput extends CreateStreamProcessor
|
|
|
6
6
|
}
|
|
7
7
|
export interface CreateStreamProcessorCommandOutput extends CreateStreamProcessorResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>
|
|
11
|
-
* <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.</p>
|
|
12
|
-
* <p>You provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
|
|
13
|
-
* face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize.
|
|
14
|
-
* Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
|
|
15
|
-
* to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
|
|
16
|
-
* the <code>Name</code> field. </p>
|
|
17
|
-
* <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
|
|
18
|
-
* stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>
|
|
19
|
-
* <p>This operation requires permissions to perform the
|
|
20
|
-
* <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
|
|
21
|
-
* @example
|
|
22
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
23
|
-
* ```javascript
|
|
24
|
-
* import { RekognitionClient, CreateStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
25
|
-
* // const { RekognitionClient, CreateStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
26
|
-
* const client = new RekognitionClient(config);
|
|
27
|
-
* const command = new CreateStreamProcessorCommand(input);
|
|
28
|
-
* const response = await client.send(command);
|
|
29
|
-
* ```
|
|
30
|
-
*
|
|
31
|
-
* @see {@link CreateStreamProcessorCommandInput} for command's `input` shape.
|
|
32
|
-
* @see {@link CreateStreamProcessorCommandOutput} for command's `response` shape.
|
|
33
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
34
|
-
*
|
|
35
|
-
*/
|
|
9
|
+
|
|
36
10
|
export declare class CreateStreamProcessorCommand extends $Command<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
|
|
37
11
|
readonly input: CreateStreamProcessorCommandInput;
|
|
38
12
|
constructor(input: CreateStreamProcessorCommandInput);
|
|
39
|
-
|
|
40
|
-
* @internal
|
|
41
|
-
*/
|
|
13
|
+
|
|
42
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput>;
|
|
43
15
|
private serialize;
|
|
44
16
|
private deserialize;
|
|
@@ -6,33 +6,11 @@ export interface DeleteCollectionCommandInput extends DeleteCollectionRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes the specified collection. Note that this operation
|
|
11
|
-
* removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>.</p>
|
|
12
|
-
*
|
|
13
|
-
* <p>This operation requires permissions to perform the
|
|
14
|
-
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
15
|
-
* @example
|
|
16
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
17
|
-
* ```javascript
|
|
18
|
-
* import { RekognitionClient, DeleteCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
19
|
-
* // const { RekognitionClient, DeleteCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
20
|
-
* const client = new RekognitionClient(config);
|
|
21
|
-
* const command = new DeleteCollectionCommand(input);
|
|
22
|
-
* const response = await client.send(command);
|
|
23
|
-
* ```
|
|
24
|
-
*
|
|
25
|
-
* @see {@link DeleteCollectionCommandInput} for command's `input` shape.
|
|
26
|
-
* @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
28
|
-
*
|
|
29
|
-
*/
|
|
9
|
+
|
|
30
10
|
export declare class DeleteCollectionCommand extends $Command<DeleteCollectionCommandInput, DeleteCollectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
31
11
|
readonly input: DeleteCollectionCommandInput;
|
|
32
12
|
constructor(input: DeleteCollectionCommandInput);
|
|
33
|
-
|
|
34
|
-
* @internal
|
|
35
|
-
*/
|
|
13
|
+
|
|
36
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCollectionCommandInput, DeleteCollectionCommandOutput>;
|
|
37
15
|
private serialize;
|
|
38
16
|
private deserialize;
|
|
@@ -6,32 +6,11 @@ export interface DeleteFacesCommandInput extends DeleteFacesRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes faces from a collection. You specify a collection ID and an array of face IDs
|
|
11
|
-
* to remove from the collection.</p>
|
|
12
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
|
|
13
|
-
* action.</p>
|
|
14
|
-
* @example
|
|
15
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
-
* ```javascript
|
|
17
|
-
* import { RekognitionClient, DeleteFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
18
|
-
* // const { RekognitionClient, DeleteFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
19
|
-
* const client = new RekognitionClient(config);
|
|
20
|
-
* const command = new DeleteFacesCommand(input);
|
|
21
|
-
* const response = await client.send(command);
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* @see {@link DeleteFacesCommandInput} for command's `input` shape.
|
|
25
|
-
* @see {@link DeleteFacesCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
27
|
-
*
|
|
28
|
-
*/
|
|
9
|
+
|
|
29
10
|
export declare class DeleteFacesCommand extends $Command<DeleteFacesCommandInput, DeleteFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
30
11
|
readonly input: DeleteFacesCommandInput;
|
|
31
12
|
constructor(input: DeleteFacesCommandInput);
|
|
32
|
-
|
|
33
|
-
* @internal
|
|
34
|
-
*/
|
|
13
|
+
|
|
35
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteFacesCommandInput, DeleteFacesCommandOutput>;
|
|
36
15
|
private serialize;
|
|
37
16
|
private deserialize;
|
|
@@ -6,32 +6,11 @@ export interface DeleteProjectCommandInput extends DeleteProjectRequest {
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
|
|
11
|
-
* with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
|
|
12
|
-
* <p>This operation requires permissions to perform the
|
|
13
|
-
* <code>rekognition:DeleteProject</code> action. </p>
|
|
14
|
-
* @example
|
|
15
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
16
|
-
* ```javascript
|
|
17
|
-
* import { RekognitionClient, DeleteProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
18
|
-
* // const { RekognitionClient, DeleteProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
19
|
-
* const client = new RekognitionClient(config);
|
|
20
|
-
* const command = new DeleteProjectCommand(input);
|
|
21
|
-
* const response = await client.send(command);
|
|
22
|
-
* ```
|
|
23
|
-
*
|
|
24
|
-
* @see {@link DeleteProjectCommandInput} for command's `input` shape.
|
|
25
|
-
* @see {@link DeleteProjectCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
27
|
-
*
|
|
28
|
-
*/
|
|
9
|
+
|
|
29
10
|
export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, RekognitionClientResolvedConfig> {
|
|
30
11
|
readonly input: DeleteProjectCommandInput;
|
|
31
12
|
constructor(input: DeleteProjectCommandInput);
|
|
32
|
-
|
|
33
|
-
* @internal
|
|
34
|
-
*/
|
|
13
|
+
|
|
35
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProjectCommandInput, DeleteProjectCommandOutput>;
|
|
36
15
|
private serialize;
|
|
37
16
|
private deserialize;
|
|
@@ -6,36 +6,11 @@ export interface DeleteProjectVersionCommandInput extends DeleteProjectVersionRe
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes an Amazon Rekognition Custom Labels model. </p>
|
|
11
|
-
* <p>You can't delete a model if it is running or if it is training.
|
|
12
|
-
* To check the status of a model, use the <code>Status</code> field returned
|
|
13
|
-
* from <a>DescribeProjectVersions</a>.
|
|
14
|
-
* To stop a running model call <a>StopProjectVersion</a>. If the model
|
|
15
|
-
* is training, wait until it finishes.</p>
|
|
16
|
-
* <p>This operation requires permissions to perform the
|
|
17
|
-
* <code>rekognition:DeleteProjectVersion</code> action. </p>
|
|
18
|
-
* @example
|
|
19
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
20
|
-
* ```javascript
|
|
21
|
-
* import { RekognitionClient, DeleteProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
22
|
-
* // const { RekognitionClient, DeleteProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
23
|
-
* const client = new RekognitionClient(config);
|
|
24
|
-
* const command = new DeleteProjectVersionCommand(input);
|
|
25
|
-
* const response = await client.send(command);
|
|
26
|
-
* ```
|
|
27
|
-
*
|
|
28
|
-
* @see {@link DeleteProjectVersionCommandInput} for command's `input` shape.
|
|
29
|
-
* @see {@link DeleteProjectVersionCommandOutput} for command's `response` shape.
|
|
30
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
9
|
+
|
|
33
10
|
export declare class DeleteProjectVersionCommand extends $Command<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
|
|
34
11
|
readonly input: DeleteProjectVersionCommandInput;
|
|
35
12
|
constructor(input: DeleteProjectVersionCommandInput);
|
|
36
|
-
|
|
37
|
-
* @internal
|
|
38
|
-
*/
|
|
13
|
+
|
|
39
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput>;
|
|
40
15
|
private serialize;
|
|
41
16
|
private deserialize;
|
|
@@ -6,30 +6,11 @@ export interface DeleteStreamProcessorCommandInput extends DeleteStreamProcessor
|
|
|
6
6
|
}
|
|
7
7
|
export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcessorResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with
|
|
11
|
-
* <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>
|
|
12
|
-
* @example
|
|
13
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
-
* ```javascript
|
|
15
|
-
* import { RekognitionClient, DeleteStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
16
|
-
* // const { RekognitionClient, DeleteStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
17
|
-
* const client = new RekognitionClient(config);
|
|
18
|
-
* const command = new DeleteStreamProcessorCommand(input);
|
|
19
|
-
* const response = await client.send(command);
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* @see {@link DeleteStreamProcessorCommandInput} for command's `input` shape.
|
|
23
|
-
* @see {@link DeleteStreamProcessorCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
9
|
+
|
|
27
10
|
export declare class DeleteStreamProcessorCommand extends $Command<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput, RekognitionClientResolvedConfig> {
|
|
28
11
|
readonly input: DeleteStreamProcessorCommandInput;
|
|
29
12
|
constructor(input: DeleteStreamProcessorCommandInput);
|
|
30
|
-
|
|
31
|
-
* @internal
|
|
32
|
-
*/
|
|
13
|
+
|
|
33
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteStreamProcessorCommandInput, DeleteStreamProcessorCommandOutput>;
|
|
34
15
|
private serialize;
|
|
35
16
|
private deserialize;
|
|
@@ -6,34 +6,11 @@ export interface DescribeCollectionCommandInput extends DescribeCollectionReques
|
|
|
6
6
|
}
|
|
7
7
|
export interface DescribeCollectionCommandOutput extends DescribeCollectionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
* <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
|
|
11
|
-
* information, such as the number of faces indexed into a collection and the version of the
|
|
12
|
-
* model used by the collection for face detection.</p>
|
|
13
|
-
*
|
|
14
|
-
* <p>For more information, see Describing a Collection in the
|
|
15
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
16
|
-
* @example
|
|
17
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
18
|
-
* ```javascript
|
|
19
|
-
* import { RekognitionClient, DescribeCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
|
|
20
|
-
* // const { RekognitionClient, DescribeCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
|
|
21
|
-
* const client = new RekognitionClient(config);
|
|
22
|
-
* const command = new DescribeCollectionCommand(input);
|
|
23
|
-
* const response = await client.send(command);
|
|
24
|
-
* ```
|
|
25
|
-
*
|
|
26
|
-
* @see {@link DescribeCollectionCommandInput} for command's `input` shape.
|
|
27
|
-
* @see {@link DescribeCollectionCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
|
|
29
|
-
*
|
|
30
|
-
*/
|
|
9
|
+
|
|
31
10
|
export declare class DescribeCollectionCommand extends $Command<DescribeCollectionCommandInput, DescribeCollectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
32
11
|
readonly input: DescribeCollectionCommandInput;
|
|
33
12
|
constructor(input: DescribeCollectionCommandInput);
|
|
34
|
-
|
|
35
|
-
* @internal
|
|
36
|
-
*/
|
|
13
|
+
|
|
37
14
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCollectionCommandInput, DescribeCollectionCommandOutput>;
|
|
38
15
|
private serialize;
|
|
39
16
|
private deserialize;
|