aws-sdk 2.583.0 → 2.587.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 +26 -1
- package/README.md +1 -1
- package/apis/apigatewayv2-2018-11-29.min.json +632 -201
- package/apis/ebs-2019-11-02.examples.json +5 -0
- package/apis/ebs-2019-11-02.min.json +195 -0
- package/apis/ebs-2019-11-02.paginators.json +14 -0
- package/apis/kafka-2018-11-14.min.json +170 -34
- package/apis/kendra-2019-02-03.min.json +2 -1
- package/apis/kinesis-video-signaling-2019-12-04.examples.json +5 -0
- package/apis/kinesis-video-signaling-2019-12-04.min.json +79 -0
- package/apis/kinesis-video-signaling-2019-12-04.paginators.json +4 -0
- package/apis/kinesisvideo-2017-09-30.min.json +281 -8
- package/apis/kinesisvideo-2017-09-30.paginators.json +6 -0
- package/apis/lambda-2015-03-31.min.json +217 -25
- package/apis/lambda-2015-03-31.paginators.json +6 -0
- package/apis/metadata.json +8 -0
- package/apis/rds-2014-10-31.min.json +495 -101
- package/apis/rds-2014-10-31.paginators.json +18 -0
- package/apis/rekognition-2016-06-27.min.json +409 -85
- package/apis/rekognition-2016-06-27.paginators.json +12 -0
- package/apis/rekognition-2016-06-27.waiters2.json +45 -0
- package/apis/sagemaker-2017-07-24.min.json +3471 -472
- package/apis/sagemaker-2017-07-24.paginators.json +128 -16
- package/apis/sagemaker-2017-07-24.waiters2.json +30 -0
- package/apis/ssm-2014-11-06.min.json +94 -71
- package/apis/states-2016-11-23.min.json +92 -55
- package/clients/all.d.ts +2 -0
- package/clients/all.js +3 -1
- package/clients/apigatewayv2.d.ts +856 -1161
- package/clients/applicationautoscaling.d.ts +32 -32
- package/clients/browser_default.d.ts +1 -0
- package/clients/browser_default.js +2 -1
- package/clients/ebs.d.ts +211 -0
- package/clients/ebs.js +18 -0
- package/clients/kafka.d.ts +152 -0
- package/clients/kendra.d.ts +7 -3
- package/clients/kinesisvideo.d.ts +312 -1
- package/clients/kinesisvideosignalingchannels.d.ts +121 -0
- package/clients/kinesisvideosignalingchannels.js +18 -0
- package/clients/kms.d.ts +6 -6
- package/clients/lambda.d.ts +199 -2
- package/clients/quicksight.d.ts +223 -223
- package/clients/rds.d.ts +549 -0
- package/clients/rekognition.d.ts +423 -8
- package/clients/rekognition.js +1 -0
- package/clients/sagemaker.d.ts +4588 -610
- package/clients/ssm.d.ts +42 -6
- package/clients/stepfunctions.d.ts +54 -0
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +1182 -1102
- package/dist/aws-sdk.js +2265 -859
- package/dist/aws-sdk.min.js +35 -35
- package/lib/config.d.ts +12 -0
- package/lib/config_service_placeholders.d.ts +4 -0
- package/lib/core.js +1 -1
- package/lib/services/s3.js +5 -4
- package/lib/services/sts.js +2 -4
- package/package.json +1 -1
- package/scripts/region-checker/whitelist.js +5 -5
package/clients/rekognition.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import {Request} from '../lib/request';
|
|
|
2
2
|
import {Response} from '../lib/response';
|
|
3
3
|
import {AWSError} from '../lib/error';
|
|
4
4
|
import {Service} from '../lib/service';
|
|
5
|
+
import {WaiterConfiguration} from '../lib/service';
|
|
5
6
|
import {ServiceConfigurationOptions} from '../lib/service';
|
|
6
7
|
import {ConfigBase as Config} from '../lib/config';
|
|
7
8
|
interface Blob {}
|
|
@@ -12,11 +13,11 @@ declare class Rekognition extends Service {
|
|
|
12
13
|
constructor(options?: Rekognition.Types.ClientConfiguration)
|
|
13
14
|
config: Config & Rekognition.Types.ClientConfiguration;
|
|
14
15
|
/**
|
|
15
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases.
|
|
16
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
16
17
|
*/
|
|
17
18
|
compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
18
19
|
/**
|
|
19
|
-
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases.
|
|
20
|
+
* Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
|
|
20
21
|
*/
|
|
21
22
|
compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
|
|
22
23
|
/**
|
|
@@ -27,6 +28,22 @@ declare class Rekognition extends Service {
|
|
|
27
28
|
* Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. When you create a collection, it is associated with the latest version of the face model version. Collection names are case-sensitive. This operation requires permissions to perform the rekognition:CreateCollection action.
|
|
28
29
|
*/
|
|
29
30
|
createCollection(callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request<Rekognition.Types.CreateCollectionResponse, AWSError>;
|
|
31
|
+
/**
|
|
32
|
+
* Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) and operations (training, evaluation and detection). This operation requires permissions to perform the rekognition:CreateProject action.
|
|
33
|
+
*/
|
|
34
|
+
createProject(params: Rekognition.Types.CreateProjectRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateProjectResponse) => void): Request<Rekognition.Types.CreateProjectResponse, AWSError>;
|
|
35
|
+
/**
|
|
36
|
+
* Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) and operations (training, evaluation and detection). This operation requires permissions to perform the rekognition:CreateProject action.
|
|
37
|
+
*/
|
|
38
|
+
createProject(callback?: (err: AWSError, data: Rekognition.Types.CreateProjectResponse) => void): Request<Rekognition.Types.CreateProjectResponse, AWSError>;
|
|
39
|
+
/**
|
|
40
|
+
* Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model. Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. After evaluating the model, you start the model by calling StartProjectVersion. This operation requires permissions to perform the rekognition:CreateProjectVersion action.
|
|
41
|
+
*/
|
|
42
|
+
createProjectVersion(params: Rekognition.Types.CreateProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateProjectVersionResponse) => void): Request<Rekognition.Types.CreateProjectVersionResponse, AWSError>;
|
|
43
|
+
/**
|
|
44
|
+
* Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model. Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. After evaluating the model, you start the model by calling StartProjectVersion. This operation requires permissions to perform the rekognition:CreateProjectVersion action.
|
|
45
|
+
*/
|
|
46
|
+
createProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.CreateProjectVersionResponse) => void): Request<Rekognition.Types.CreateProjectVersionResponse, AWSError>;
|
|
30
47
|
/**
|
|
31
48
|
* Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. 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. You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
|
|
32
49
|
*/
|
|
@@ -67,6 +84,22 @@ declare class Rekognition extends Service {
|
|
|
67
84
|
* Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
|
|
68
85
|
*/
|
|
69
86
|
describeCollection(callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request<Rekognition.Types.DescribeCollectionResponse, AWSError>;
|
|
87
|
+
/**
|
|
88
|
+
* Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned. This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
|
|
89
|
+
*/
|
|
90
|
+
describeProjectVersions(params: Rekognition.Types.DescribeProjectVersionsRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
91
|
+
/**
|
|
92
|
+
* Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned. This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
|
|
93
|
+
*/
|
|
94
|
+
describeProjectVersions(callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
95
|
+
/**
|
|
96
|
+
* Lists and gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the rekognition:DescribeProjects action.
|
|
97
|
+
*/
|
|
98
|
+
describeProjects(params: Rekognition.Types.DescribeProjectsRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectsResponse) => void): Request<Rekognition.Types.DescribeProjectsResponse, AWSError>;
|
|
99
|
+
/**
|
|
100
|
+
* Lists and gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the rekognition:DescribeProjects action.
|
|
101
|
+
*/
|
|
102
|
+
describeProjects(callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectsResponse) => void): Request<Rekognition.Types.DescribeProjectsResponse, AWSError>;
|
|
70
103
|
/**
|
|
71
104
|
* Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
|
|
72
105
|
*/
|
|
@@ -75,6 +108,14 @@ declare class Rekognition extends Service {
|
|
|
75
108
|
* Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
|
|
76
109
|
*/
|
|
77
110
|
describeStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request<Rekognition.Types.DescribeStreamProcessorResponse, AWSError>;
|
|
111
|
+
/**
|
|
112
|
+
* Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. You specify which version of a model version to use by using the ProjectVersionArn input parameter. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn't return labels whose confidence value is below the model's calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model's calculated threshold. You can get the model's calculated threshold from the model's training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0. You can also add the MaxResults parameter to limit the number of labels returned. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectCustomLabels action.
|
|
113
|
+
*/
|
|
114
|
+
detectCustomLabels(params: Rekognition.Types.DetectCustomLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectCustomLabelsResponse) => void): Request<Rekognition.Types.DetectCustomLabelsResponse, AWSError>;
|
|
115
|
+
/**
|
|
116
|
+
* Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. You specify which version of a model version to use by using the ProjectVersionArn input parameter. You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn't return labels whose confidence value is below the model's calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model's calculated threshold. You can get the model's calculated threshold from the model's training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0. You can also add the MaxResults parameter to limit the number of labels returned. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectCustomLabels action.
|
|
117
|
+
*/
|
|
118
|
+
detectCustomLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectCustomLabelsResponse) => void): Request<Rekognition.Types.DetectCustomLabelsResponse, AWSError>;
|
|
78
119
|
/**
|
|
79
120
|
* Detects faces within an image that is provided as input. DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action.
|
|
80
121
|
*/
|
|
@@ -212,11 +253,11 @@ declare class Rekognition extends Service {
|
|
|
212
253
|
*/
|
|
213
254
|
searchFaces(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request<Rekognition.Types.SearchFacesResponse, AWSError>;
|
|
214
255
|
/**
|
|
215
|
-
* For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases.
|
|
256
|
+
* For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. This operation requires permissions to perform the rekognition:SearchFacesByImage action.
|
|
216
257
|
*/
|
|
217
258
|
searchFacesByImage(params: Rekognition.Types.SearchFacesByImageRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
|
|
218
259
|
/**
|
|
219
|
-
* For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases.
|
|
260
|
+
* For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE. To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection. This operation requires permissions to perform the rekognition:SearchFacesByImage action.
|
|
220
261
|
*/
|
|
221
262
|
searchFacesByImage(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
|
|
222
263
|
/**
|
|
@@ -267,6 +308,14 @@ declare class Rekognition extends Service {
|
|
|
267
308
|
* Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.
|
|
268
309
|
*/
|
|
269
310
|
startPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request<Rekognition.Types.StartPersonTrackingResponse, AWSError>;
|
|
311
|
+
/**
|
|
312
|
+
* Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions. Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels. You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion. This operation requires permissions to perform the rekognition:StartProjectVersion action.
|
|
313
|
+
*/
|
|
314
|
+
startProjectVersion(params: Rekognition.Types.StartProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartProjectVersionResponse) => void): Request<Rekognition.Types.StartProjectVersionResponse, AWSError>;
|
|
315
|
+
/**
|
|
316
|
+
* Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions. Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels. You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion. This operation requires permissions to perform the rekognition:StartProjectVersion action.
|
|
317
|
+
*/
|
|
318
|
+
startProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.StartProjectVersionResponse) => void): Request<Rekognition.Types.StartProjectVersionResponse, AWSError>;
|
|
270
319
|
/**
|
|
271
320
|
* Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.
|
|
272
321
|
*/
|
|
@@ -275,6 +324,14 @@ declare class Rekognition extends Service {
|
|
|
275
324
|
* Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.
|
|
276
325
|
*/
|
|
277
326
|
startStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request<Rekognition.Types.StartStreamProcessorResponse, AWSError>;
|
|
327
|
+
/**
|
|
328
|
+
* Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.
|
|
329
|
+
*/
|
|
330
|
+
stopProjectVersion(params: Rekognition.Types.StopProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.StopProjectVersionResponse) => void): Request<Rekognition.Types.StopProjectVersionResponse, AWSError>;
|
|
331
|
+
/**
|
|
332
|
+
* Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.
|
|
333
|
+
*/
|
|
334
|
+
stopProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.StopProjectVersionResponse) => void): Request<Rekognition.Types.StopProjectVersionResponse, AWSError>;
|
|
278
335
|
/**
|
|
279
336
|
* Stops a running stream processor that was created by CreateStreamProcessor.
|
|
280
337
|
*/
|
|
@@ -283,6 +340,22 @@ declare class Rekognition extends Service {
|
|
|
283
340
|
* Stops a running stream processor that was created by CreateStreamProcessor.
|
|
284
341
|
*/
|
|
285
342
|
stopStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
|
|
343
|
+
/**
|
|
344
|
+
* Waits for the projectVersionTrainingCompleted state by periodically calling the underlying Rekognition.describeProjectVersionsoperation every 120 seconds (at most 360 times). Wait until the ProjectVersion training completes.
|
|
345
|
+
*/
|
|
346
|
+
waitFor(state: "projectVersionTrainingCompleted", params: Rekognition.Types.DescribeProjectVersionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
347
|
+
/**
|
|
348
|
+
* Waits for the projectVersionTrainingCompleted state by periodically calling the underlying Rekognition.describeProjectVersionsoperation every 120 seconds (at most 360 times). Wait until the ProjectVersion training completes.
|
|
349
|
+
*/
|
|
350
|
+
waitFor(state: "projectVersionTrainingCompleted", callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
351
|
+
/**
|
|
352
|
+
* Waits for the projectVersionRunning state by periodically calling the underlying Rekognition.describeProjectVersionsoperation every 30 seconds (at most 40 times). Wait until the ProjectVersion is running.
|
|
353
|
+
*/
|
|
354
|
+
waitFor(state: "projectVersionRunning", params: Rekognition.Types.DescribeProjectVersionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
355
|
+
/**
|
|
356
|
+
* Waits for the projectVersionRunning state by periodically calling the underlying Rekognition.describeProjectVersionsoperation every 30 seconds (at most 40 times). Wait until the ProjectVersion is running.
|
|
357
|
+
*/
|
|
358
|
+
waitFor(state: "projectVersionRunning", callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
|
|
286
359
|
}
|
|
287
360
|
declare namespace Rekognition {
|
|
288
361
|
export interface AgeRange {
|
|
@@ -295,6 +368,10 @@ declare namespace Rekognition {
|
|
|
295
368
|
*/
|
|
296
369
|
High?: UInteger;
|
|
297
370
|
}
|
|
371
|
+
export interface Asset {
|
|
372
|
+
GroundTruthManifest?: GroundTruthManifest;
|
|
373
|
+
}
|
|
374
|
+
export type Assets = Asset[];
|
|
298
375
|
export type Attribute = "DEFAULT"|"ALL"|string;
|
|
299
376
|
export type Attributes = Attribute[];
|
|
300
377
|
export interface Beard {
|
|
@@ -415,7 +492,7 @@ declare namespace Rekognition {
|
|
|
415
492
|
*/
|
|
416
493
|
SimilarityThreshold?: Percent;
|
|
417
494
|
/**
|
|
418
|
-
* A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The
|
|
495
|
+
* A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE. To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
|
|
419
496
|
*/
|
|
420
497
|
QualityFilter?: QualityFilter;
|
|
421
498
|
}
|
|
@@ -475,6 +552,8 @@ declare namespace Rekognition {
|
|
|
475
552
|
*/
|
|
476
553
|
Confidence?: Percent;
|
|
477
554
|
}
|
|
555
|
+
export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string;
|
|
556
|
+
export type ContentClassifiers = ContentClassifier[];
|
|
478
557
|
export interface ContentModerationDetection {
|
|
479
558
|
/**
|
|
480
559
|
* Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.
|
|
@@ -507,6 +586,46 @@ declare namespace Rekognition {
|
|
|
507
586
|
*/
|
|
508
587
|
FaceModelVersion?: String;
|
|
509
588
|
}
|
|
589
|
+
export interface CreateProjectRequest {
|
|
590
|
+
/**
|
|
591
|
+
* The name of the project to create.
|
|
592
|
+
*/
|
|
593
|
+
ProjectName: ProjectName;
|
|
594
|
+
}
|
|
595
|
+
export interface CreateProjectResponse {
|
|
596
|
+
/**
|
|
597
|
+
* The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.
|
|
598
|
+
*/
|
|
599
|
+
ProjectArn?: ProjectArn;
|
|
600
|
+
}
|
|
601
|
+
export interface CreateProjectVersionRequest {
|
|
602
|
+
/**
|
|
603
|
+
* The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
|
|
604
|
+
*/
|
|
605
|
+
ProjectArn: ProjectArn;
|
|
606
|
+
/**
|
|
607
|
+
* A name for the version of the model. This value must be unique.
|
|
608
|
+
*/
|
|
609
|
+
VersionName: VersionName;
|
|
610
|
+
/**
|
|
611
|
+
* The Amazon S3 location to store the results of training.
|
|
612
|
+
*/
|
|
613
|
+
OutputConfig: OutputConfig;
|
|
614
|
+
/**
|
|
615
|
+
* The dataset to use for training.
|
|
616
|
+
*/
|
|
617
|
+
TrainingData: TrainingData;
|
|
618
|
+
/**
|
|
619
|
+
* The dataset to use for testing.
|
|
620
|
+
*/
|
|
621
|
+
TestingData: TestingData;
|
|
622
|
+
}
|
|
623
|
+
export interface CreateProjectVersionResponse {
|
|
624
|
+
/**
|
|
625
|
+
* The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.
|
|
626
|
+
*/
|
|
627
|
+
ProjectVersionArn?: ProjectVersionArn;
|
|
628
|
+
}
|
|
510
629
|
export interface CreateStreamProcessorRequest {
|
|
511
630
|
/**
|
|
512
631
|
* Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.
|
|
@@ -535,6 +654,21 @@ declare namespace Rekognition {
|
|
|
535
654
|
*/
|
|
536
655
|
StreamProcessorArn?: StreamProcessorArn;
|
|
537
656
|
}
|
|
657
|
+
export interface CustomLabel {
|
|
658
|
+
/**
|
|
659
|
+
* The name of the custom label.
|
|
660
|
+
*/
|
|
661
|
+
Name?: String;
|
|
662
|
+
/**
|
|
663
|
+
* The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.
|
|
664
|
+
*/
|
|
665
|
+
Confidence?: Percent;
|
|
666
|
+
/**
|
|
667
|
+
* The location of the detected object on the image that corresponds to the custom label. Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon for more accurate spatial information.
|
|
668
|
+
*/
|
|
669
|
+
Geometry?: Geometry;
|
|
670
|
+
}
|
|
671
|
+
export type CustomLabels = CustomLabel[];
|
|
538
672
|
export type DateTime = Date;
|
|
539
673
|
export type Degree = number;
|
|
540
674
|
export interface DeleteCollectionRequest {
|
|
@@ -597,6 +731,54 @@ declare namespace Rekognition {
|
|
|
597
731
|
*/
|
|
598
732
|
CreationTimestamp?: DateTime;
|
|
599
733
|
}
|
|
734
|
+
export interface DescribeProjectVersionsRequest {
|
|
735
|
+
/**
|
|
736
|
+
* The Amazon Resource Name (ARN) of the project that contains the models you want to describe.
|
|
737
|
+
*/
|
|
738
|
+
ProjectArn: ProjectArn;
|
|
739
|
+
/**
|
|
740
|
+
* A list of model version names that you want to describe. You can add up to 10 model version names to the list. If you don't specify a value, all model descriptions are returned.
|
|
741
|
+
*/
|
|
742
|
+
VersionNames?: VersionNames;
|
|
743
|
+
/**
|
|
744
|
+
* If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
|
|
745
|
+
*/
|
|
746
|
+
NextToken?: ExtendedPaginationToken;
|
|
747
|
+
/**
|
|
748
|
+
* The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
|
|
749
|
+
*/
|
|
750
|
+
MaxResults?: ProjectVersionsPageSize;
|
|
751
|
+
}
|
|
752
|
+
export interface DescribeProjectVersionsResponse {
|
|
753
|
+
/**
|
|
754
|
+
* A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.
|
|
755
|
+
*/
|
|
756
|
+
ProjectVersionDescriptions?: ProjectVersionDescriptions;
|
|
757
|
+
/**
|
|
758
|
+
* If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
|
|
759
|
+
*/
|
|
760
|
+
NextToken?: ExtendedPaginationToken;
|
|
761
|
+
}
|
|
762
|
+
export interface DescribeProjectsRequest {
|
|
763
|
+
/**
|
|
764
|
+
* If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
|
|
765
|
+
*/
|
|
766
|
+
NextToken?: ExtendedPaginationToken;
|
|
767
|
+
/**
|
|
768
|
+
* The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
|
|
769
|
+
*/
|
|
770
|
+
MaxResults?: ProjectsPageSize;
|
|
771
|
+
}
|
|
772
|
+
export interface DescribeProjectsResponse {
|
|
773
|
+
/**
|
|
774
|
+
* A list of project descriptions. The list is sorted by the date and time the projects are created.
|
|
775
|
+
*/
|
|
776
|
+
ProjectDescriptions?: ProjectDescriptions;
|
|
777
|
+
/**
|
|
778
|
+
* If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
|
|
779
|
+
*/
|
|
780
|
+
NextToken?: ExtendedPaginationToken;
|
|
781
|
+
}
|
|
600
782
|
export interface DescribeStreamProcessorRequest {
|
|
601
783
|
/**
|
|
602
784
|
* Name of the stream processor for which you want information.
|
|
@@ -645,6 +827,27 @@ declare namespace Rekognition {
|
|
|
645
827
|
*/
|
|
646
828
|
Settings?: StreamProcessorSettings;
|
|
647
829
|
}
|
|
830
|
+
export interface DetectCustomLabelsRequest {
|
|
831
|
+
/**
|
|
832
|
+
* The ARN of the model version that you want to use.
|
|
833
|
+
*/
|
|
834
|
+
ProjectVersionArn: ProjectVersionArn;
|
|
835
|
+
Image: Image;
|
|
836
|
+
/**
|
|
837
|
+
* Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.
|
|
838
|
+
*/
|
|
839
|
+
MaxResults?: UInteger;
|
|
840
|
+
/**
|
|
841
|
+
* Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
|
|
842
|
+
*/
|
|
843
|
+
MinConfidence?: Percent;
|
|
844
|
+
}
|
|
845
|
+
export interface DetectCustomLabelsResponse {
|
|
846
|
+
/**
|
|
847
|
+
* An array of custom labels detected in the input image.
|
|
848
|
+
*/
|
|
849
|
+
CustomLabels?: CustomLabels;
|
|
850
|
+
}
|
|
648
851
|
export interface DetectFacesRequest {
|
|
649
852
|
/**
|
|
650
853
|
* The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
|
|
@@ -702,6 +905,10 @@ declare namespace Rekognition {
|
|
|
702
905
|
* Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value. If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.
|
|
703
906
|
*/
|
|
704
907
|
MinConfidence?: Percent;
|
|
908
|
+
/**
|
|
909
|
+
* Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.
|
|
910
|
+
*/
|
|
911
|
+
HumanLoopConfig?: HumanLoopConfig;
|
|
705
912
|
}
|
|
706
913
|
export interface DetectModerationLabelsResponse {
|
|
707
914
|
/**
|
|
@@ -712,6 +919,10 @@ declare namespace Rekognition {
|
|
|
712
919
|
* Version number of the moderation detection model that was used to detect unsafe content.
|
|
713
920
|
*/
|
|
714
921
|
ModerationModelVersion?: String;
|
|
922
|
+
/**
|
|
923
|
+
* Shows the results of the human in the loop evaluation.
|
|
924
|
+
*/
|
|
925
|
+
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
715
926
|
}
|
|
716
927
|
export interface DetectTextRequest {
|
|
717
928
|
/**
|
|
@@ -737,6 +948,17 @@ declare namespace Rekognition {
|
|
|
737
948
|
}
|
|
738
949
|
export type EmotionName = "HAPPY"|"SAD"|"ANGRY"|"CONFUSED"|"DISGUSTED"|"SURPRISED"|"CALM"|"UNKNOWN"|"FEAR"|string;
|
|
739
950
|
export type Emotions = Emotion[];
|
|
951
|
+
export interface EvaluationResult {
|
|
952
|
+
/**
|
|
953
|
+
* The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.
|
|
954
|
+
*/
|
|
955
|
+
F1Score?: Float;
|
|
956
|
+
/**
|
|
957
|
+
* The S3 bucket that contains the training summary.
|
|
958
|
+
*/
|
|
959
|
+
Summary?: Summary;
|
|
960
|
+
}
|
|
961
|
+
export type ExtendedPaginationToken = string;
|
|
740
962
|
export type ExternalImageId = string;
|
|
741
963
|
export interface EyeOpen {
|
|
742
964
|
/**
|
|
@@ -893,6 +1115,7 @@ declare namespace Rekognition {
|
|
|
893
1115
|
}
|
|
894
1116
|
export type FaceSearchSortBy = "INDEX"|"TIMESTAMP"|string;
|
|
895
1117
|
export type Float = number;
|
|
1118
|
+
export type FlowDefinitionArn = string;
|
|
896
1119
|
export interface Gender {
|
|
897
1120
|
/**
|
|
898
1121
|
* The predicted gender of the face.
|
|
@@ -906,11 +1129,11 @@ declare namespace Rekognition {
|
|
|
906
1129
|
export type GenderType = "Male"|"Female"|string;
|
|
907
1130
|
export interface Geometry {
|
|
908
1131
|
/**
|
|
909
|
-
* An axis-aligned coarse representation of the detected
|
|
1132
|
+
* An axis-aligned coarse representation of the detected item's location on the image.
|
|
910
1133
|
*/
|
|
911
1134
|
BoundingBox?: BoundingBox;
|
|
912
1135
|
/**
|
|
913
|
-
* Within the bounding box, a fine-grained polygon around the detected
|
|
1136
|
+
* Within the bounding box, a fine-grained polygon around the detected item.
|
|
914
1137
|
*/
|
|
915
1138
|
Polygon?: Polygon;
|
|
916
1139
|
}
|
|
@@ -1174,6 +1397,48 @@ declare namespace Rekognition {
|
|
|
1174
1397
|
*/
|
|
1175
1398
|
Persons?: PersonDetections;
|
|
1176
1399
|
}
|
|
1400
|
+
export interface GroundTruthManifest {
|
|
1401
|
+
S3Object?: S3Object;
|
|
1402
|
+
}
|
|
1403
|
+
export type HumanLoopActivationConditionsEvaluationResults = string;
|
|
1404
|
+
export interface HumanLoopActivationOutput {
|
|
1405
|
+
/**
|
|
1406
|
+
* The Amazon Resource Name (ARN) of the HumanLoop created.
|
|
1407
|
+
*/
|
|
1408
|
+
HumanLoopArn?: HumanLoopArn;
|
|
1409
|
+
/**
|
|
1410
|
+
* Shows if and why human review was needed.
|
|
1411
|
+
*/
|
|
1412
|
+
HumanLoopActivationReasons?: HumanLoopActivationReasons;
|
|
1413
|
+
/**
|
|
1414
|
+
* Shows the result of condition evaluations, including those conditions which activated a human review.
|
|
1415
|
+
*/
|
|
1416
|
+
HumanLoopActivationConditionsEvaluationResults?: HumanLoopActivationConditionsEvaluationResults;
|
|
1417
|
+
}
|
|
1418
|
+
export type HumanLoopActivationReason = string;
|
|
1419
|
+
export type HumanLoopActivationReasons = HumanLoopActivationReason[];
|
|
1420
|
+
export type HumanLoopArn = string;
|
|
1421
|
+
export interface HumanLoopConfig {
|
|
1422
|
+
/**
|
|
1423
|
+
* The name of the human review used for this image. This should be kept unique within a region.
|
|
1424
|
+
*/
|
|
1425
|
+
HumanLoopName: HumanLoopName;
|
|
1426
|
+
/**
|
|
1427
|
+
* The Amazon Resource Name (ARN) of the flow definition.
|
|
1428
|
+
*/
|
|
1429
|
+
FlowDefinitionArn: FlowDefinitionArn;
|
|
1430
|
+
/**
|
|
1431
|
+
* Sets attributes of the input data.
|
|
1432
|
+
*/
|
|
1433
|
+
DataAttributes?: HumanLoopDataAttributes;
|
|
1434
|
+
}
|
|
1435
|
+
export interface HumanLoopDataAttributes {
|
|
1436
|
+
/**
|
|
1437
|
+
* Sets whether the input image is free of personally identifiable information.
|
|
1438
|
+
*/
|
|
1439
|
+
ContentClassifiers?: ContentClassifiers;
|
|
1440
|
+
}
|
|
1441
|
+
export type HumanLoopName = string;
|
|
1177
1442
|
export interface Image {
|
|
1178
1443
|
/**
|
|
1179
1444
|
* Blob of image bytes up to 5 MBs.
|
|
@@ -1240,6 +1505,7 @@ declare namespace Rekognition {
|
|
|
1240
1505
|
*/
|
|
1241
1506
|
UnindexedFaces?: UnindexedFaces;
|
|
1242
1507
|
}
|
|
1508
|
+
export type InferenceUnits = number;
|
|
1243
1509
|
export interface Instance {
|
|
1244
1510
|
/**
|
|
1245
1511
|
* The position of the label instance on the image.
|
|
@@ -1435,6 +1701,16 @@ declare namespace Rekognition {
|
|
|
1435
1701
|
RoleArn: RoleArn;
|
|
1436
1702
|
}
|
|
1437
1703
|
export type OrientationCorrection = "ROTATE_0"|"ROTATE_90"|"ROTATE_180"|"ROTATE_270"|string;
|
|
1704
|
+
export interface OutputConfig {
|
|
1705
|
+
/**
|
|
1706
|
+
* The S3 bucket where training output is placed.
|
|
1707
|
+
*/
|
|
1708
|
+
S3Bucket?: S3Bucket;
|
|
1709
|
+
/**
|
|
1710
|
+
* The prefix applied to the training output files.
|
|
1711
|
+
*/
|
|
1712
|
+
S3KeyPrefix?: S3KeyPrefix;
|
|
1713
|
+
}
|
|
1438
1714
|
export type PageSize = number;
|
|
1439
1715
|
export type PaginationToken = string;
|
|
1440
1716
|
export interface Parent {
|
|
@@ -1512,6 +1788,75 @@ declare namespace Rekognition {
|
|
|
1512
1788
|
*/
|
|
1513
1789
|
Pitch?: Degree;
|
|
1514
1790
|
}
|
|
1791
|
+
export type ProjectArn = string;
|
|
1792
|
+
export interface ProjectDescription {
|
|
1793
|
+
/**
|
|
1794
|
+
* The Amazon Resource Name (ARN) of the project.
|
|
1795
|
+
*/
|
|
1796
|
+
ProjectArn?: ProjectArn;
|
|
1797
|
+
/**
|
|
1798
|
+
* The Unix timestamp for the date and time that the project was created.
|
|
1799
|
+
*/
|
|
1800
|
+
CreationTimestamp?: DateTime;
|
|
1801
|
+
/**
|
|
1802
|
+
* The current status of the project.
|
|
1803
|
+
*/
|
|
1804
|
+
Status?: ProjectStatus;
|
|
1805
|
+
}
|
|
1806
|
+
export type ProjectDescriptions = ProjectDescription[];
|
|
1807
|
+
export type ProjectName = string;
|
|
1808
|
+
export type ProjectStatus = "CREATING"|"CREATED"|"DELETING"|string;
|
|
1809
|
+
export type ProjectVersionArn = string;
|
|
1810
|
+
export interface ProjectVersionDescription {
|
|
1811
|
+
/**
|
|
1812
|
+
* The Amazon Resource Name (ARN) of the model version.
|
|
1813
|
+
*/
|
|
1814
|
+
ProjectVersionArn?: ProjectVersionArn;
|
|
1815
|
+
/**
|
|
1816
|
+
* The Unix datetime for the date and time that training started.
|
|
1817
|
+
*/
|
|
1818
|
+
CreationTimestamp?: DateTime;
|
|
1819
|
+
/**
|
|
1820
|
+
* The minimum number of inference units used by the model. For more information, see StartProjectVersion.
|
|
1821
|
+
*/
|
|
1822
|
+
MinInferenceUnits?: InferenceUnits;
|
|
1823
|
+
/**
|
|
1824
|
+
* The current status of the model version.
|
|
1825
|
+
*/
|
|
1826
|
+
Status?: ProjectVersionStatus;
|
|
1827
|
+
/**
|
|
1828
|
+
* A descriptive message for an error or warning that occurred.
|
|
1829
|
+
*/
|
|
1830
|
+
StatusMessage?: StatusMessage;
|
|
1831
|
+
/**
|
|
1832
|
+
* The duration, in seconds, that the model version has been billed for training. This value is only returned if the model version has been successfully trained.
|
|
1833
|
+
*/
|
|
1834
|
+
BillableTrainingTimeInSeconds?: ULong;
|
|
1835
|
+
/**
|
|
1836
|
+
* The Unix date and time that training of the model ended.
|
|
1837
|
+
*/
|
|
1838
|
+
TrainingEndTimestamp?: DateTime;
|
|
1839
|
+
/**
|
|
1840
|
+
* The location where training results are saved.
|
|
1841
|
+
*/
|
|
1842
|
+
OutputConfig?: OutputConfig;
|
|
1843
|
+
/**
|
|
1844
|
+
* The manifest file that represents the training results.
|
|
1845
|
+
*/
|
|
1846
|
+
TrainingDataResult?: TrainingDataResult;
|
|
1847
|
+
/**
|
|
1848
|
+
* The manifest file that represents the testing results.
|
|
1849
|
+
*/
|
|
1850
|
+
TestingDataResult?: TestingDataResult;
|
|
1851
|
+
/**
|
|
1852
|
+
* The training results. EvaluationResult is only returned if training is successful.
|
|
1853
|
+
*/
|
|
1854
|
+
EvaluationResult?: EvaluationResult;
|
|
1855
|
+
}
|
|
1856
|
+
export type ProjectVersionDescriptions = ProjectVersionDescription[];
|
|
1857
|
+
export type ProjectVersionStatus = "TRAINING_IN_PROGRESS"|"TRAINING_COMPLETED"|"TRAINING_FAILED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|string;
|
|
1858
|
+
export type ProjectVersionsPageSize = number;
|
|
1859
|
+
export type ProjectsPageSize = number;
|
|
1515
1860
|
export type QualityFilter = "NONE"|"AUTO"|"LOW"|"MEDIUM"|"HIGH"|string;
|
|
1516
1861
|
export type Reason = "EXCEEDS_MAX_FACES"|"EXTREME_POSE"|"LOW_BRIGHTNESS"|"LOW_SHARPNESS"|"LOW_CONFIDENCE"|"SMALL_BOUNDING_BOX"|"LOW_FACE_QUALITY"|string;
|
|
1517
1862
|
export type Reasons = Reason[];
|
|
@@ -1538,6 +1883,7 @@ declare namespace Rekognition {
|
|
|
1538
1883
|
export type RekognitionUniqueId = string;
|
|
1539
1884
|
export type RoleArn = string;
|
|
1540
1885
|
export type S3Bucket = string;
|
|
1886
|
+
export type S3KeyPrefix = string;
|
|
1541
1887
|
export interface S3Object {
|
|
1542
1888
|
/**
|
|
1543
1889
|
* Name of the S3 bucket.
|
|
@@ -1573,7 +1919,7 @@ declare namespace Rekognition {
|
|
|
1573
1919
|
*/
|
|
1574
1920
|
FaceMatchThreshold?: Percent;
|
|
1575
1921
|
/**
|
|
1576
|
-
* A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The
|
|
1922
|
+
* A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE. To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
|
|
1577
1923
|
*/
|
|
1578
1924
|
QualityFilter?: QualityFilter;
|
|
1579
1925
|
}
|
|
@@ -1801,6 +2147,22 @@ declare namespace Rekognition {
|
|
|
1801
2147
|
*/
|
|
1802
2148
|
JobId?: JobId;
|
|
1803
2149
|
}
|
|
2150
|
+
export interface StartProjectVersionRequest {
|
|
2151
|
+
/**
|
|
2152
|
+
* The Amazon Resource Name(ARN) of the model version that you want to start.
|
|
2153
|
+
*/
|
|
2154
|
+
ProjectVersionArn: ProjectVersionArn;
|
|
2155
|
+
/**
|
|
2156
|
+
* The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
|
|
2157
|
+
*/
|
|
2158
|
+
MinInferenceUnits: InferenceUnits;
|
|
2159
|
+
}
|
|
2160
|
+
export interface StartProjectVersionResponse {
|
|
2161
|
+
/**
|
|
2162
|
+
* The current running status of the model.
|
|
2163
|
+
*/
|
|
2164
|
+
Status?: ProjectVersionStatus;
|
|
2165
|
+
}
|
|
1804
2166
|
export interface StartStreamProcessorRequest {
|
|
1805
2167
|
/**
|
|
1806
2168
|
* The name of the stream processor to start processing.
|
|
@@ -1810,6 +2172,18 @@ declare namespace Rekognition {
|
|
|
1810
2172
|
export interface StartStreamProcessorResponse {
|
|
1811
2173
|
}
|
|
1812
2174
|
export type StatusMessage = string;
|
|
2175
|
+
export interface StopProjectVersionRequest {
|
|
2176
|
+
/**
|
|
2177
|
+
* The Amazon Resource Name (ARN) of the model version that you want to delete. This operation requires permissions to perform the rekognition:StopProjectVersion action.
|
|
2178
|
+
*/
|
|
2179
|
+
ProjectVersionArn: ProjectVersionArn;
|
|
2180
|
+
}
|
|
2181
|
+
export interface StopProjectVersionResponse {
|
|
2182
|
+
/**
|
|
2183
|
+
* The current status of the stop operation.
|
|
2184
|
+
*/
|
|
2185
|
+
Status?: ProjectVersionStatus;
|
|
2186
|
+
}
|
|
1813
2187
|
export interface StopStreamProcessorRequest {
|
|
1814
2188
|
/**
|
|
1815
2189
|
* The name of a stream processor created by CreateStreamProcessor.
|
|
@@ -1851,6 +2225,9 @@ declare namespace Rekognition {
|
|
|
1851
2225
|
}
|
|
1852
2226
|
export type StreamProcessorStatus = "STOPPED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|string;
|
|
1853
2227
|
export type String = string;
|
|
2228
|
+
export interface Summary {
|
|
2229
|
+
S3Object?: S3Object;
|
|
2230
|
+
}
|
|
1854
2231
|
export interface Sunglasses {
|
|
1855
2232
|
/**
|
|
1856
2233
|
* Boolean value that indicates whether the face is wearing sunglasses or not.
|
|
@@ -1861,6 +2238,26 @@ declare namespace Rekognition {
|
|
|
1861
2238
|
*/
|
|
1862
2239
|
Confidence?: Percent;
|
|
1863
2240
|
}
|
|
2241
|
+
export interface TestingData {
|
|
2242
|
+
/**
|
|
2243
|
+
* The assets used for testing.
|
|
2244
|
+
*/
|
|
2245
|
+
Assets?: Assets;
|
|
2246
|
+
/**
|
|
2247
|
+
* If specified, Amazon Rekognition Custom Labels creates a testing dataset with an 80/20 split of the training dataset.
|
|
2248
|
+
*/
|
|
2249
|
+
AutoCreate?: Boolean;
|
|
2250
|
+
}
|
|
2251
|
+
export interface TestingDataResult {
|
|
2252
|
+
/**
|
|
2253
|
+
* The testing dataset that was supplied for training.
|
|
2254
|
+
*/
|
|
2255
|
+
Input?: TestingData;
|
|
2256
|
+
/**
|
|
2257
|
+
* The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.
|
|
2258
|
+
*/
|
|
2259
|
+
Output?: TestingData;
|
|
2260
|
+
}
|
|
1864
2261
|
export interface TextDetection {
|
|
1865
2262
|
/**
|
|
1866
2263
|
* The word or line of text recognized by Amazon Rekognition.
|
|
@@ -1890,6 +2287,22 @@ declare namespace Rekognition {
|
|
|
1890
2287
|
export type TextDetectionList = TextDetection[];
|
|
1891
2288
|
export type TextTypes = "LINE"|"WORD"|string;
|
|
1892
2289
|
export type Timestamp = number;
|
|
2290
|
+
export interface TrainingData {
|
|
2291
|
+
/**
|
|
2292
|
+
* A Sagemaker GroundTruth manifest file that contains the training images (assets).
|
|
2293
|
+
*/
|
|
2294
|
+
Assets?: Assets;
|
|
2295
|
+
}
|
|
2296
|
+
export interface TrainingDataResult {
|
|
2297
|
+
/**
|
|
2298
|
+
* The training assets that you supplied for training.
|
|
2299
|
+
*/
|
|
2300
|
+
Input?: TrainingData;
|
|
2301
|
+
/**
|
|
2302
|
+
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
|
|
2303
|
+
*/
|
|
2304
|
+
Output?: TrainingData;
|
|
2305
|
+
}
|
|
1893
2306
|
export type UInteger = number;
|
|
1894
2307
|
export type ULong = number;
|
|
1895
2308
|
export interface UnindexedFace {
|
|
@@ -1905,6 +2318,8 @@ declare namespace Rekognition {
|
|
|
1905
2318
|
export type UnindexedFaces = UnindexedFace[];
|
|
1906
2319
|
export type Url = string;
|
|
1907
2320
|
export type Urls = Url[];
|
|
2321
|
+
export type VersionName = string;
|
|
2322
|
+
export type VersionNames = VersionName[];
|
|
1908
2323
|
export interface Video {
|
|
1909
2324
|
/**
|
|
1910
2325
|
* The Amazon S3 bucket name and file name for the video.
|