@aws-sdk/client-rekognition 3.425.0 → 3.428.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/models/models_0.js +12 -12
- package/dist-cjs/models/models_1.js +11 -1
- package/dist-cjs/protocols/Aws_json1_1.js +48 -1
- package/dist-es/models/models_0.js +10 -10
- package/dist-es/models/models_1.js +10 -0
- package/dist-es/protocols/Aws_json1_1.js +48 -1
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +12 -5
- package/dist-types/commands/CreateDatasetCommand.d.ts +9 -4
- package/dist-types/commands/CreateProjectCommand.d.ts +13 -6
- package/dist-types/commands/CreateProjectVersionCommand.d.ts +29 -22
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +5 -3
- package/dist-types/commands/DeleteDatasetCommand.d.ts +9 -4
- package/dist-types/commands/DeleteProjectCommand.d.ts +2 -2
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +4 -1
- package/dist-types/commands/DeleteProjectVersionCommand.d.ts +6 -7
- package/dist-types/commands/DescribeDatasetCommand.d.ts +4 -1
- package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +12 -4
- package/dist-types/commands/DescribeProjectsCommand.d.ts +6 -1
- package/dist-types/commands/DetectCustomLabelsCommand.d.ts +9 -4
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +12 -0
- package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +4 -1
- package/dist-types/commands/ListDatasetEntriesCommand.d.ts +4 -1
- package/dist-types/commands/ListDatasetLabelsCommand.d.ts +4 -1
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +4 -1
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +12 -6
- package/dist-types/commands/SearchUsersByImageCommand.d.ts +2 -1
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +6 -5
- package/dist-types/commands/StartContentModerationCommand.d.ts +5 -3
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +5 -3
- package/dist-types/commands/StartFaceSearchCommand.d.ts +5 -3
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +5 -3
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +5 -3
- package/dist-types/commands/StartProjectVersionCommand.d.ts +11 -7
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +5 -3
- package/dist-types/commands/StartTextDetectionCommand.d.ts +5 -3
- package/dist-types/commands/StopProjectVersionCommand.d.ts +7 -3
- package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +9 -4
- package/dist-types/models/models_0.d.ts +187 -175
- package/dist-types/models/models_1.d.ts +124 -7
- package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +33 -28
- package/dist-types/ts3.4/models/models_1.d.ts +31 -0
- package/package.json +32 -32
|
@@ -1809,9 +1809,11 @@ export interface CopyProjectVersionResponse {
|
|
|
1809
1809
|
}
|
|
1810
1810
|
/**
|
|
1811
1811
|
* @public
|
|
1812
|
-
* <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1812
|
+
* <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
|
|
1813
|
+
* concurrently, subsequent calls to start operations (ex:
|
|
1814
|
+
* <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
|
|
1815
|
+
* exception (HTTP status code: 400) until the number of concurrently running jobs is below
|
|
1816
|
+
* the Amazon Rekognition service limit. </p>
|
|
1815
1817
|
*/
|
|
1816
1818
|
export declare class LimitExceededException extends __BaseException {
|
|
1817
1819
|
readonly name: "LimitExceededException";
|
|
@@ -2063,6 +2065,30 @@ export interface CreateFaceLivenessSessionResponse {
|
|
|
2063
2065
|
*/
|
|
2064
2066
|
SessionId: string | undefined;
|
|
2065
2067
|
}
|
|
2068
|
+
/**
|
|
2069
|
+
* @public
|
|
2070
|
+
* @enum
|
|
2071
|
+
*/
|
|
2072
|
+
export declare const ProjectAutoUpdate: {
|
|
2073
|
+
readonly DISABLED: "DISABLED";
|
|
2074
|
+
readonly ENABLED: "ENABLED";
|
|
2075
|
+
};
|
|
2076
|
+
/**
|
|
2077
|
+
* @public
|
|
2078
|
+
*/
|
|
2079
|
+
export type ProjectAutoUpdate = (typeof ProjectAutoUpdate)[keyof typeof ProjectAutoUpdate];
|
|
2080
|
+
/**
|
|
2081
|
+
* @public
|
|
2082
|
+
* @enum
|
|
2083
|
+
*/
|
|
2084
|
+
export declare const CustomizationFeature: {
|
|
2085
|
+
readonly CONTENT_MODERATION: "CONTENT_MODERATION";
|
|
2086
|
+
readonly CUSTOM_LABELS: "CUSTOM_LABELS";
|
|
2087
|
+
};
|
|
2088
|
+
/**
|
|
2089
|
+
* @public
|
|
2090
|
+
*/
|
|
2091
|
+
export type CustomizationFeature = (typeof CustomizationFeature)[keyof typeof CustomizationFeature];
|
|
2066
2092
|
/**
|
|
2067
2093
|
* @public
|
|
2068
2094
|
*/
|
|
@@ -2072,6 +2098,18 @@ export interface CreateProjectRequest {
|
|
|
2072
2098
|
* <p>The name of the project to create.</p>
|
|
2073
2099
|
*/
|
|
2074
2100
|
ProjectName: string | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* @public
|
|
2103
|
+
* <p>Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.</p>
|
|
2104
|
+
*/
|
|
2105
|
+
Feature?: CustomizationFeature | string;
|
|
2106
|
+
/**
|
|
2107
|
+
* @public
|
|
2108
|
+
* <p>Specifies whether automatic retraining should be attempted for the versions of the
|
|
2109
|
+
* project. Automatic retraining is done as a best effort. Required argument for Content
|
|
2110
|
+
* Moderation. Applicable only to adapters.</p>
|
|
2111
|
+
*/
|
|
2112
|
+
AutoUpdate?: ProjectAutoUpdate | string;
|
|
2075
2113
|
}
|
|
2076
2114
|
/**
|
|
2077
2115
|
* @public
|
|
@@ -2086,7 +2124,31 @@ export interface CreateProjectResponse {
|
|
|
2086
2124
|
}
|
|
2087
2125
|
/**
|
|
2088
2126
|
* @public
|
|
2089
|
-
* <p>
|
|
2127
|
+
* <p>Configuration options for Content Moderation training.</p>
|
|
2128
|
+
*/
|
|
2129
|
+
export interface CustomizationFeatureContentModerationConfig {
|
|
2130
|
+
/**
|
|
2131
|
+
* @public
|
|
2132
|
+
* <p>The confidence level you plan to use to identify if unsafe content is present during inference.</p>
|
|
2133
|
+
*/
|
|
2134
|
+
ConfidenceThreshold?: number;
|
|
2135
|
+
}
|
|
2136
|
+
/**
|
|
2137
|
+
* @public
|
|
2138
|
+
* <p>Feature specific configuration for the training job. Configuration provided for the job must match
|
|
2139
|
+
* the feature type parameter associated with project. If configuration
|
|
2140
|
+
* and feature type do not match an InvalidParameterException is returned.</p>
|
|
2141
|
+
*/
|
|
2142
|
+
export interface CustomizationFeatureConfig {
|
|
2143
|
+
/**
|
|
2144
|
+
* @public
|
|
2145
|
+
* <p>Configuration options for Custom Moderation training.</p>
|
|
2146
|
+
*/
|
|
2147
|
+
ContentModeration?: CustomizationFeatureContentModerationConfig;
|
|
2148
|
+
}
|
|
2149
|
+
/**
|
|
2150
|
+
* @public
|
|
2151
|
+
* <p>The dataset used for testing. Optionally, if <code>AutoCreate</code> is set, Amazon Rekognition uses the
|
|
2090
2152
|
* training dataset to create a test dataset with a temporary split of the training dataset. </p>
|
|
2091
2153
|
*/
|
|
2092
2154
|
export interface TestingData {
|
|
@@ -2097,8 +2159,8 @@ export interface TestingData {
|
|
|
2097
2159
|
Assets?: Asset[];
|
|
2098
2160
|
/**
|
|
2099
2161
|
* @public
|
|
2100
|
-
* <p>If specified,
|
|
2101
|
-
*
|
|
2162
|
+
* <p>If specified, Rekognition splits training dataset to create a test dataset for
|
|
2163
|
+
* the training job.</p>
|
|
2102
2164
|
*/
|
|
2103
2165
|
AutoCreate?: boolean;
|
|
2104
2166
|
}
|
|
@@ -2109,7 +2171,8 @@ export interface TestingData {
|
|
|
2109
2171
|
export interface TrainingData {
|
|
2110
2172
|
/**
|
|
2111
2173
|
* @public
|
|
2112
|
-
* <p>A
|
|
2174
|
+
* <p>A manifest file that contains references to the training images and ground-truth
|
|
2175
|
+
* annotations.</p>
|
|
2113
2176
|
*/
|
|
2114
2177
|
Assets?: Asset[];
|
|
2115
2178
|
}
|
|
@@ -2119,50 +2182,49 @@ export interface TrainingData {
|
|
|
2119
2182
|
export interface CreateProjectVersionRequest {
|
|
2120
2183
|
/**
|
|
2121
2184
|
* @public
|
|
2122
|
-
* <p>The ARN of the Amazon Rekognition
|
|
2123
|
-
*
|
|
2185
|
+
* <p>The ARN of the Amazon Rekognition project that will manage the project version you want to
|
|
2186
|
+
* train.</p>
|
|
2124
2187
|
*/
|
|
2125
2188
|
ProjectArn: string | undefined;
|
|
2126
2189
|
/**
|
|
2127
2190
|
* @public
|
|
2128
|
-
* <p>A name for the version of the
|
|
2191
|
+
* <p>A name for the version of the project version. This value must be unique.</p>
|
|
2129
2192
|
*/
|
|
2130
2193
|
VersionName: string | undefined;
|
|
2131
2194
|
/**
|
|
2132
2195
|
* @public
|
|
2133
|
-
* <p>The Amazon S3 bucket location to store the results of training.
|
|
2134
|
-
*
|
|
2135
|
-
*
|
|
2196
|
+
* <p>The Amazon S3 bucket location to store the results of training. The bucket can be any S3
|
|
2197
|
+
* bucket in your AWS account. You need <code>s3:PutObject</code> permission on the bucket.
|
|
2198
|
+
* </p>
|
|
2136
2199
|
*/
|
|
2137
2200
|
OutputConfig: OutputConfig | undefined;
|
|
2138
2201
|
/**
|
|
2139
2202
|
* @public
|
|
2140
|
-
* <p>Specifies an external manifest that the services uses to train the
|
|
2203
|
+
* <p>Specifies an external manifest that the services uses to train the project version.
|
|
2141
2204
|
* If you specify <code>TrainingData</code> you must also specify <code>TestingData</code>.
|
|
2142
|
-
* The project must not have any associated datasets.
|
|
2143
|
-
* </p>
|
|
2205
|
+
* The project must not have any associated datasets. </p>
|
|
2144
2206
|
*/
|
|
2145
2207
|
TrainingData?: TrainingData;
|
|
2146
2208
|
/**
|
|
2147
2209
|
* @public
|
|
2148
|
-
* <p>Specifies an external manifest that the service uses to test the
|
|
2149
|
-
*
|
|
2150
|
-
*
|
|
2210
|
+
* <p>Specifies an external manifest that the service uses to test the project version. If
|
|
2211
|
+
* you specify <code>TestingData</code> you must also specify <code>TrainingData</code>. The
|
|
2212
|
+
* project must not have any associated datasets.</p>
|
|
2151
2213
|
*/
|
|
2152
2214
|
TestingData?: TestingData;
|
|
2153
2215
|
/**
|
|
2154
2216
|
* @public
|
|
2155
|
-
* <p> A set of tags (key-value pairs) that you want to attach to the
|
|
2217
|
+
* <p> A set of tags (key-value pairs) that you want to attach to the project version. </p>
|
|
2156
2218
|
*/
|
|
2157
2219
|
Tags?: Record<string, string>;
|
|
2158
2220
|
/**
|
|
2159
2221
|
* @public
|
|
2160
|
-
* <p>The identifier for your AWS Key Management Service key (AWS KMS key).
|
|
2161
|
-
*
|
|
2162
|
-
*
|
|
2163
|
-
*
|
|
2164
|
-
*
|
|
2165
|
-
*
|
|
2222
|
+
* <p>The identifier for your AWS Key Management Service key (AWS KMS key). You can supply
|
|
2223
|
+
* the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for
|
|
2224
|
+
* your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied
|
|
2225
|
+
* into the service for the project version. Your source images are unaffected. The
|
|
2226
|
+
* key is also used to encrypt training results and manifest files written to the output Amazon S3
|
|
2227
|
+
* bucket (<code>OutputConfig</code>).</p>
|
|
2166
2228
|
* <p>If you choose to use your own KMS key, you need the following permissions on the KMS key.</p>
|
|
2167
2229
|
* <ul>
|
|
2168
2230
|
* <li>
|
|
@@ -2182,6 +2244,16 @@ export interface CreateProjectVersionRequest {
|
|
|
2182
2244
|
* using a key that AWS owns and manages.</p>
|
|
2183
2245
|
*/
|
|
2184
2246
|
KmsKeyId?: string;
|
|
2247
|
+
/**
|
|
2248
|
+
* @public
|
|
2249
|
+
* <p>A description applied to the project version being created.</p>
|
|
2250
|
+
*/
|
|
2251
|
+
VersionDescription?: string;
|
|
2252
|
+
/**
|
|
2253
|
+
* @public
|
|
2254
|
+
* <p>Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.</p>
|
|
2255
|
+
*/
|
|
2256
|
+
FeatureConfig?: CustomizationFeatureConfig;
|
|
2185
2257
|
}
|
|
2186
2258
|
/**
|
|
2187
2259
|
* @public
|
|
@@ -2189,8 +2261,9 @@ export interface CreateProjectVersionRequest {
|
|
|
2189
2261
|
export interface CreateProjectVersionResponse {
|
|
2190
2262
|
/**
|
|
2191
2263
|
* @public
|
|
2192
|
-
* <p>The ARN of the model version that was created. Use
|
|
2193
|
-
*
|
|
2264
|
+
* <p>The ARN of the model or the project version that was created. Use
|
|
2265
|
+
* <code>DescribeProjectVersion</code> to get the current status of the training
|
|
2266
|
+
* operation.</p>
|
|
2194
2267
|
*/
|
|
2195
2268
|
ProjectVersionArn?: string;
|
|
2196
2269
|
}
|
|
@@ -2973,7 +3046,8 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
|
|
|
2973
3046
|
export interface DeleteProjectVersionRequest {
|
|
2974
3047
|
/**
|
|
2975
3048
|
* @public
|
|
2976
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3049
|
+
* <p>The Amazon Resource Name (ARN) of the project version that you want to
|
|
3050
|
+
* delete.</p>
|
|
2977
3051
|
*/
|
|
2978
3052
|
ProjectVersionArn: string | undefined;
|
|
2979
3053
|
}
|
|
@@ -2986,6 +3060,8 @@ export declare const ProjectVersionStatus: {
|
|
|
2986
3060
|
readonly COPYING_FAILED: "COPYING_FAILED";
|
|
2987
3061
|
readonly COPYING_IN_PROGRESS: "COPYING_IN_PROGRESS";
|
|
2988
3062
|
readonly DELETING: "DELETING";
|
|
3063
|
+
readonly DEPRECATED: "DEPRECATED";
|
|
3064
|
+
readonly EXPIRED: "EXPIRED";
|
|
2989
3065
|
readonly FAILED: "FAILED";
|
|
2990
3066
|
readonly RUNNING: "RUNNING";
|
|
2991
3067
|
readonly STARTING: "STARTING";
|
|
@@ -3126,7 +3202,7 @@ export interface DescribeProjectsRequest {
|
|
|
3126
3202
|
/**
|
|
3127
3203
|
* @public
|
|
3128
3204
|
* <p>If the previous response was incomplete (because there is more
|
|
3129
|
-
* results to retrieve),
|
|
3205
|
+
* results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination
|
|
3130
3206
|
* token to retrieve the next set of results. </p>
|
|
3131
3207
|
*/
|
|
3132
3208
|
NextToken?: string;
|
|
@@ -3139,10 +3215,16 @@ export interface DescribeProjectsRequest {
|
|
|
3139
3215
|
MaxResults?: number;
|
|
3140
3216
|
/**
|
|
3141
3217
|
* @public
|
|
3142
|
-
* <p>A list of the projects that you want
|
|
3218
|
+
* <p>A list of the projects that you want Rekognition to describe. If you don't specify a value,
|
|
3143
3219
|
* the response includes descriptions for all the projects in your AWS account.</p>
|
|
3144
3220
|
*/
|
|
3145
3221
|
ProjectNames?: string[];
|
|
3222
|
+
/**
|
|
3223
|
+
* @public
|
|
3224
|
+
* <p>Specifies the type of customization to filter projects by. If no value is specified,
|
|
3225
|
+
* CUSTOM_LABELS is used as a default.</p>
|
|
3226
|
+
*/
|
|
3227
|
+
Features?: (CustomizationFeature | string)[];
|
|
3146
3228
|
}
|
|
3147
3229
|
/**
|
|
3148
3230
|
* @public
|
|
@@ -3171,6 +3253,16 @@ export interface ProjectDescription {
|
|
|
3171
3253
|
* </p>
|
|
3172
3254
|
*/
|
|
3173
3255
|
Datasets?: DatasetMetadata[];
|
|
3256
|
+
/**
|
|
3257
|
+
* @public
|
|
3258
|
+
* <p>Specifies the project that is being customized.</p>
|
|
3259
|
+
*/
|
|
3260
|
+
Feature?: CustomizationFeature | string;
|
|
3261
|
+
/**
|
|
3262
|
+
* @public
|
|
3263
|
+
* <p>Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters. </p>
|
|
3264
|
+
*/
|
|
3265
|
+
AutoUpdate?: ProjectAutoUpdate | string;
|
|
3174
3266
|
}
|
|
3175
3267
|
/**
|
|
3176
3268
|
* @public
|
|
@@ -3184,7 +3276,7 @@ export interface DescribeProjectsResponse {
|
|
|
3184
3276
|
/**
|
|
3185
3277
|
* @public
|
|
3186
3278
|
* <p>If the previous response was incomplete (because there is more
|
|
3187
|
-
* results to retrieve), Amazon Rekognition
|
|
3279
|
+
* results to retrieve), Amazon Rekognition returns a pagination token in the response.
|
|
3188
3280
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
3189
3281
|
*/
|
|
3190
3282
|
NextToken?: string;
|
|
@@ -3214,21 +3306,23 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
3214
3306
|
export interface DescribeProjectVersionsRequest {
|
|
3215
3307
|
/**
|
|
3216
3308
|
* @public
|
|
3217
|
-
* <p>The Amazon Resource Name (ARN) of the project that contains the
|
|
3309
|
+
* <p>The Amazon Resource Name (ARN) of the project that contains the model/adapter you want
|
|
3310
|
+
* to describe.</p>
|
|
3218
3311
|
*/
|
|
3219
3312
|
ProjectArn: string | undefined;
|
|
3220
3313
|
/**
|
|
3221
3314
|
* @public
|
|
3222
|
-
* <p>A list of model version names that you want to describe. You can add
|
|
3223
|
-
* to the list. If you don't specify a value, all
|
|
3224
|
-
*
|
|
3315
|
+
* <p>A list of model or project version names that you want to describe. You can add
|
|
3316
|
+
* up to 10 model or project version names to the list. If you don't specify a value, all
|
|
3317
|
+
* project version descriptions are returned. A version name is part of a project version ARN. For example, <code>my-model.2020-01-21T09.10.15</code> is
|
|
3318
|
+
* the version name in the following ARN.
|
|
3225
3319
|
* <code>arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/<i>my-model.2020-01-21T09.10.15</i>/1234567890123</code>.</p>
|
|
3226
3320
|
*/
|
|
3227
3321
|
VersionNames?: string[];
|
|
3228
3322
|
/**
|
|
3229
3323
|
* @public
|
|
3230
3324
|
* <p>If the previous response was incomplete (because there is more
|
|
3231
|
-
* results to retrieve), Amazon Rekognition
|
|
3325
|
+
* results to retrieve), Amazon Rekognition returns a pagination token in the response.
|
|
3232
3326
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
3233
3327
|
*/
|
|
3234
3328
|
NextToken?: string;
|
|
@@ -3302,7 +3396,8 @@ export interface ValidationData {
|
|
|
3302
3396
|
}
|
|
3303
3397
|
/**
|
|
3304
3398
|
* @public
|
|
3305
|
-
* <p>Sagemaker Groundtruth format manifest files for the input, output and validation
|
|
3399
|
+
* <p>Sagemaker Groundtruth format manifest files for the input, output and validation
|
|
3400
|
+
* datasets that are used and created during testing.</p>
|
|
3306
3401
|
*/
|
|
3307
3402
|
export interface TestingDataResult {
|
|
3308
3403
|
/**
|
|
@@ -3324,33 +3419,36 @@ export interface TestingDataResult {
|
|
|
3324
3419
|
}
|
|
3325
3420
|
/**
|
|
3326
3421
|
* @public
|
|
3327
|
-
* <p>
|
|
3422
|
+
* <p>The data
|
|
3423
|
+
* validation manifest created for the training dataset during model training.</p>
|
|
3328
3424
|
*/
|
|
3329
3425
|
export interface TrainingDataResult {
|
|
3330
3426
|
/**
|
|
3331
3427
|
* @public
|
|
3332
|
-
* <p>The training
|
|
3428
|
+
* <p>The training data that you supplied.</p>
|
|
3333
3429
|
*/
|
|
3334
3430
|
Input?: TrainingData;
|
|
3335
3431
|
/**
|
|
3336
3432
|
* @public
|
|
3337
|
-
* <p>
|
|
3433
|
+
* <p>Reference to images (assets) that were actually used during training with trained model
|
|
3434
|
+
* predictions.</p>
|
|
3338
3435
|
*/
|
|
3339
3436
|
Output?: TrainingData;
|
|
3340
3437
|
/**
|
|
3341
3438
|
* @public
|
|
3342
|
-
* <p>
|
|
3439
|
+
* <p>A manifest that you supplied for training, with validation results for each
|
|
3440
|
+
* line.</p>
|
|
3343
3441
|
*/
|
|
3344
3442
|
Validation?: ValidationData;
|
|
3345
3443
|
}
|
|
3346
3444
|
/**
|
|
3347
3445
|
* @public
|
|
3348
|
-
* <p>A description of a version of
|
|
3446
|
+
* <p>A description of a version of a Amazon Rekognition project version.</p>
|
|
3349
3447
|
*/
|
|
3350
3448
|
export interface ProjectVersionDescription {
|
|
3351
3449
|
/**
|
|
3352
3450
|
* @public
|
|
3353
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
3451
|
+
* <p>The Amazon Resource Name (ARN) of the project version. </p>
|
|
3354
3452
|
*/
|
|
3355
3453
|
ProjectVersionArn?: string;
|
|
3356
3454
|
/**
|
|
@@ -3360,8 +3458,8 @@ export interface ProjectVersionDescription {
|
|
|
3360
3458
|
CreationTimestamp?: Date;
|
|
3361
3459
|
/**
|
|
3362
3460
|
* @public
|
|
3363
|
-
* <p>The minimum number of inference units used by the model.
|
|
3364
|
-
*
|
|
3461
|
+
* <p>The minimum number of inference units used by the model. Applies only to Custom Labels
|
|
3462
|
+
* projects. For more information, see <a>StartProjectVersion</a>.</p>
|
|
3365
3463
|
*/
|
|
3366
3464
|
MinInferenceUnits?: number;
|
|
3367
3465
|
/**
|
|
@@ -3418,8 +3516,8 @@ export interface ProjectVersionDescription {
|
|
|
3418
3516
|
KmsKeyId?: string;
|
|
3419
3517
|
/**
|
|
3420
3518
|
* @public
|
|
3421
|
-
* <p>The maximum number of inference units Amazon Rekognition
|
|
3422
|
-
* For more information, see <a>StartProjectVersion</a>.</p>
|
|
3519
|
+
* <p>The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies
|
|
3520
|
+
* only to Custom Labels projects. For more information, see <a>StartProjectVersion</a>.</p>
|
|
3423
3521
|
*/
|
|
3424
3522
|
MaxInferenceUnits?: number;
|
|
3425
3523
|
/**
|
|
@@ -3427,6 +3525,26 @@ export interface ProjectVersionDescription {
|
|
|
3427
3525
|
* <p>If the model version was copied from a different project, <code>SourceProjectVersionArn</code> contains the ARN of the source model version. </p>
|
|
3428
3526
|
*/
|
|
3429
3527
|
SourceProjectVersionArn?: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* @public
|
|
3530
|
+
* <p>A user-provided description of the project version.</p>
|
|
3531
|
+
*/
|
|
3532
|
+
VersionDescription?: string;
|
|
3533
|
+
/**
|
|
3534
|
+
* @public
|
|
3535
|
+
* <p>The feature that was customized.</p>
|
|
3536
|
+
*/
|
|
3537
|
+
Feature?: CustomizationFeature | string;
|
|
3538
|
+
/**
|
|
3539
|
+
* @public
|
|
3540
|
+
* <p>The base detection model version used to create the project version.</p>
|
|
3541
|
+
*/
|
|
3542
|
+
BaseModelVersion?: string;
|
|
3543
|
+
/**
|
|
3544
|
+
* @public
|
|
3545
|
+
* <p>Feature specific configuration that was applied during training.</p>
|
|
3546
|
+
*/
|
|
3547
|
+
FeatureConfig?: CustomizationFeatureConfig;
|
|
3430
3548
|
}
|
|
3431
3549
|
/**
|
|
3432
3550
|
* @public
|
|
@@ -3434,14 +3552,14 @@ export interface ProjectVersionDescription {
|
|
|
3434
3552
|
export interface DescribeProjectVersionsResponse {
|
|
3435
3553
|
/**
|
|
3436
3554
|
* @public
|
|
3437
|
-
* <p>A list of
|
|
3438
|
-
* the
|
|
3555
|
+
* <p>A list of project version descriptions. The list is sorted by the creation date and
|
|
3556
|
+
* time of the project versions, latest to earliest.</p>
|
|
3439
3557
|
*/
|
|
3440
3558
|
ProjectVersionDescriptions?: ProjectVersionDescription[];
|
|
3441
3559
|
/**
|
|
3442
3560
|
* @public
|
|
3443
3561
|
* <p>If the previous response was incomplete (because there is more
|
|
3444
|
-
* results to retrieve), Amazon Rekognition
|
|
3562
|
+
* results to retrieve), Amazon Rekognition returns a pagination token in the response.
|
|
3445
3563
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
3446
3564
|
*/
|
|
3447
3565
|
NextToken?: string;
|
|
@@ -3566,7 +3684,10 @@ export interface DescribeStreamProcessorResponse {
|
|
|
3566
3684
|
export interface DetectCustomLabelsRequest {
|
|
3567
3685
|
/**
|
|
3568
3686
|
* @public
|
|
3569
|
-
* <p>The ARN of the model version that you want to use
|
|
3687
|
+
* <p>The ARN of the model version that you want to use. Only models associated with Custom
|
|
3688
|
+
* Labels projects accepted by the operation. If a provided ARN refers to a model version
|
|
3689
|
+
* associated with a project for a different feature type, then an InvalidParameterException
|
|
3690
|
+
* is returned.</p>
|
|
3570
3691
|
*/
|
|
3571
3692
|
ProjectVersionArn: string | undefined;
|
|
3572
3693
|
/**
|
|
@@ -4161,6 +4282,12 @@ export interface DetectModerationLabelsRequest {
|
|
|
4161
4282
|
* will be sent to.</p>
|
|
4162
4283
|
*/
|
|
4163
4284
|
HumanLoopConfig?: HumanLoopConfig;
|
|
4285
|
+
/**
|
|
4286
|
+
* @public
|
|
4287
|
+
* <p>Identifier for the custom adapter. Expects the ProjectVersionArn as a value.
|
|
4288
|
+
* Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.</p>
|
|
4289
|
+
*/
|
|
4290
|
+
ProjectVersion?: string;
|
|
4164
4291
|
}
|
|
4165
4292
|
/**
|
|
4166
4293
|
* @public
|
|
@@ -4197,7 +4324,7 @@ export interface DetectModerationLabelsResponse {
|
|
|
4197
4324
|
ModerationLabels?: ModerationLabel[];
|
|
4198
4325
|
/**
|
|
4199
4326
|
* @public
|
|
4200
|
-
* <p>Version number of the moderation detection model that was used to detect unsafe
|
|
4327
|
+
* <p>Version number of the base moderation detection model that was used to detect unsafe
|
|
4201
4328
|
* content.</p>
|
|
4202
4329
|
*/
|
|
4203
4330
|
ModerationModelVersion?: string;
|
|
@@ -4206,6 +4333,13 @@ export interface DetectModerationLabelsResponse {
|
|
|
4206
4333
|
* <p>Shows the results of the human in the loop evaluation.</p>
|
|
4207
4334
|
*/
|
|
4208
4335
|
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
4336
|
+
/**
|
|
4337
|
+
* @public
|
|
4338
|
+
* <p>Identifier of the custom adapter that was used during inference. If
|
|
4339
|
+
* during inference the adapter was EXPIRED, then the parameter will not be returned,
|
|
4340
|
+
* indicating that a base moderation detection project version was used.</p>
|
|
4341
|
+
*/
|
|
4342
|
+
ProjectVersion?: string;
|
|
4209
4343
|
}
|
|
4210
4344
|
/**
|
|
4211
4345
|
* @public
|
|
@@ -7084,128 +7218,6 @@ export interface SearchedFaceDetails {
|
|
|
7084
7218
|
*/
|
|
7085
7219
|
FaceDetail?: FaceDetail;
|
|
7086
7220
|
}
|
|
7087
|
-
/**
|
|
7088
|
-
* @public
|
|
7089
|
-
* @enum
|
|
7090
|
-
*/
|
|
7091
|
-
export declare const UnsearchedFaceReason: {
|
|
7092
|
-
readonly EXCEEDS_MAX_FACES: "EXCEEDS_MAX_FACES";
|
|
7093
|
-
readonly EXTREME_POSE: "EXTREME_POSE";
|
|
7094
|
-
readonly FACE_NOT_LARGEST: "FACE_NOT_LARGEST";
|
|
7095
|
-
readonly LOW_BRIGHTNESS: "LOW_BRIGHTNESS";
|
|
7096
|
-
readonly LOW_CONFIDENCE: "LOW_CONFIDENCE";
|
|
7097
|
-
readonly LOW_FACE_QUALITY: "LOW_FACE_QUALITY";
|
|
7098
|
-
readonly LOW_SHARPNESS: "LOW_SHARPNESS";
|
|
7099
|
-
readonly SMALL_BOUNDING_BOX: "SMALL_BOUNDING_BOX";
|
|
7100
|
-
};
|
|
7101
|
-
/**
|
|
7102
|
-
* @public
|
|
7103
|
-
*/
|
|
7104
|
-
export type UnsearchedFaceReason = (typeof UnsearchedFaceReason)[keyof typeof UnsearchedFaceReason];
|
|
7105
|
-
/**
|
|
7106
|
-
* @public
|
|
7107
|
-
* <p>Face details inferred from the image but not used for search. The response attribute
|
|
7108
|
-
* contains reasons for why a face wasn't used for Search. </p>
|
|
7109
|
-
*/
|
|
7110
|
-
export interface UnsearchedFace {
|
|
7111
|
-
/**
|
|
7112
|
-
* @public
|
|
7113
|
-
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
7114
|
-
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
7115
|
-
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
7116
|
-
* <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
|
|
7117
|
-
* <code>Quality</code>.</p>
|
|
7118
|
-
* <p>
|
|
7119
|
-
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
7120
|
-
* return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
|
|
7121
|
-
* return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
|
|
7122
|
-
* attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
|
|
7123
|
-
* parameter:</p>
|
|
7124
|
-
* <ul>
|
|
7125
|
-
* <li>
|
|
7126
|
-
* <p>GetCelebrityRecognition</p>
|
|
7127
|
-
* </li>
|
|
7128
|
-
* <li>
|
|
7129
|
-
* <p>GetPersonTracking</p>
|
|
7130
|
-
* </li>
|
|
7131
|
-
* <li>
|
|
7132
|
-
* <p>GetFaceSearch</p>
|
|
7133
|
-
* </li>
|
|
7134
|
-
* </ul>
|
|
7135
|
-
* <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
|
|
7136
|
-
* can return all facial attributes. To specify which attributes to return, use the
|
|
7137
|
-
* <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
|
|
7138
|
-
* <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
|
|
7139
|
-
*/
|
|
7140
|
-
FaceDetails?: FaceDetail;
|
|
7141
|
-
/**
|
|
7142
|
-
* @public
|
|
7143
|
-
* <p> Reasons why a face wasn't used for Search. </p>
|
|
7144
|
-
*/
|
|
7145
|
-
Reasons?: (UnsearchedFaceReason | string)[];
|
|
7146
|
-
}
|
|
7147
|
-
/**
|
|
7148
|
-
* @public
|
|
7149
|
-
*/
|
|
7150
|
-
export interface SearchUsersByImageResponse {
|
|
7151
|
-
/**
|
|
7152
|
-
* @public
|
|
7153
|
-
* <p>An array of UserID objects that matched the input face, along with the confidence in the
|
|
7154
|
-
* match. The returned structure will be empty if there are no matches. Returned if the
|
|
7155
|
-
* SearchUsersByImageResponse action is successful.</p>
|
|
7156
|
-
*/
|
|
7157
|
-
UserMatches?: UserMatch[];
|
|
7158
|
-
/**
|
|
7159
|
-
* @public
|
|
7160
|
-
* <p>Version number of the face detection model associated with the input collection
|
|
7161
|
-
* CollectionId.</p>
|
|
7162
|
-
*/
|
|
7163
|
-
FaceModelVersion?: string;
|
|
7164
|
-
/**
|
|
7165
|
-
* @public
|
|
7166
|
-
* <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image, as
|
|
7167
|
-
* well as the confidence in the bounding box, that was searched for matches. If no valid face is
|
|
7168
|
-
* detected in the image the response will contain no SearchedFace object.</p>
|
|
7169
|
-
*/
|
|
7170
|
-
SearchedFace?: SearchedFaceDetails;
|
|
7171
|
-
/**
|
|
7172
|
-
* @public
|
|
7173
|
-
* <p>List of UnsearchedFace objects. Contains the face details infered from the specified image
|
|
7174
|
-
* but not used for search. Contains reasons that describe why a face wasn't used for Search.
|
|
7175
|
-
* </p>
|
|
7176
|
-
*/
|
|
7177
|
-
UnsearchedFaces?: UnsearchedFace[];
|
|
7178
|
-
}
|
|
7179
|
-
/**
|
|
7180
|
-
* @public
|
|
7181
|
-
*/
|
|
7182
|
-
export interface StartCelebrityRecognitionRequest {
|
|
7183
|
-
/**
|
|
7184
|
-
* @public
|
|
7185
|
-
* <p>The video in which you want to recognize celebrities. The video must be stored
|
|
7186
|
-
* in an Amazon S3 bucket.</p>
|
|
7187
|
-
*/
|
|
7188
|
-
Video: Video | undefined;
|
|
7189
|
-
/**
|
|
7190
|
-
* @public
|
|
7191
|
-
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
7192
|
-
* <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use
|
|
7193
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
7194
|
-
*/
|
|
7195
|
-
ClientRequestToken?: string;
|
|
7196
|
-
/**
|
|
7197
|
-
* @public
|
|
7198
|
-
* <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
|
|
7199
|
-
* celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
7200
|
-
*/
|
|
7201
|
-
NotificationChannel?: NotificationChannel;
|
|
7202
|
-
/**
|
|
7203
|
-
* @public
|
|
7204
|
-
* <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
|
|
7205
|
-
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
7206
|
-
*/
|
|
7207
|
-
JobTag?: string;
|
|
7208
|
-
}
|
|
7209
7221
|
/**
|
|
7210
7222
|
* @internal
|
|
7211
7223
|
*/
|