UNPKG

205 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class Rekognition extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: Rekognition.Types.ClientConfiguration)
14 config: Config & Rekognition.Types.ClientConfiguration;
15 /**
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.
17 */
18 compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
19 /**
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.
21 */
22 compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
23 /**
24 * 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.
25 */
26 createCollection(params: Rekognition.Types.CreateCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request<Rekognition.Types.CreateCollectionResponse, AWSError>;
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.
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>;
47 /**
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.
49 */
50 createStreamProcessor(params: Rekognition.Types.CreateStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request<Rekognition.Types.CreateStreamProcessorResponse, AWSError>;
51 /**
52 * 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.
53 */
54 createStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request<Rekognition.Types.CreateStreamProcessorResponse, AWSError>;
55 /**
56 * Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure. This operation requires permissions to perform the rekognition:DeleteCollection action.
57 */
58 deleteCollection(params: Rekognition.Types.DeleteCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request<Rekognition.Types.DeleteCollectionResponse, AWSError>;
59 /**
60 * Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure. This operation requires permissions to perform the rekognition:DeleteCollection action.
61 */
62 deleteCollection(callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request<Rekognition.Types.DeleteCollectionResponse, AWSError>;
63 /**
64 * Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the rekognition:DeleteFaces action.
65 */
66 deleteFaces(params: Rekognition.Types.DeleteFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request<Rekognition.Types.DeleteFacesResponse, AWSError>;
67 /**
68 * Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. This operation requires permissions to perform the rekognition:DeleteFaces action.
69 */
70 deleteFaces(callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request<Rekognition.Types.DeleteFacesResponse, AWSError>;
71 /**
72 * Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all versions of the model associated with the project. To delete a version of a model, see DeleteProjectVersion. This operation requires permissions to perform the rekognition:DeleteProject action.
73 */
74 deleteProject(params: Rekognition.Types.DeleteProjectRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteProjectResponse) => void): Request<Rekognition.Types.DeleteProjectResponse, AWSError>;
75 /**
76 * Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all versions of the model associated with the project. To delete a version of a model, see DeleteProjectVersion. This operation requires permissions to perform the rekognition:DeleteProject action.
77 */
78 deleteProject(callback?: (err: AWSError, data: Rekognition.Types.DeleteProjectResponse) => void): Request<Rekognition.Types.DeleteProjectResponse, AWSError>;
79 /**
80 * Deletes a version of a model. You must first stop the model before you can delete it. To check if a model is running, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
81 */
82 deleteProjectVersion(params: Rekognition.Types.DeleteProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteProjectVersionResponse) => void): Request<Rekognition.Types.DeleteProjectVersionResponse, AWSError>;
83 /**
84 * Deletes a version of a model. You must first stop the model before you can delete it. To check if a model is running, use the Status field returned from DescribeProjectVersions. To stop a running model call StopProjectVersion. This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
85 */
86 deleteProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.DeleteProjectVersionResponse) => void): Request<Rekognition.Types.DeleteProjectVersionResponse, AWSError>;
87 /**
88 * Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.
89 */
90 deleteStreamProcessor(params: Rekognition.Types.DeleteStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request<Rekognition.Types.DeleteStreamProcessorResponse, AWSError>;
91 /**
92 * Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.
93 */
94 deleteStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request<Rekognition.Types.DeleteStreamProcessorResponse, AWSError>;
95 /**
96 * 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.
97 */
98 describeCollection(params: Rekognition.Types.DescribeCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request<Rekognition.Types.DescribeCollectionResponse, AWSError>;
99 /**
100 * 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.
101 */
102 describeCollection(callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request<Rekognition.Types.DescribeCollectionResponse, AWSError>;
103 /**
104 * 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.
105 */
106 describeProjectVersions(params: Rekognition.Types.DescribeProjectVersionsRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
107 /**
108 * 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.
109 */
110 describeProjectVersions(callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
111 /**
112 * Lists and gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the rekognition:DescribeProjects action.
113 */
114 describeProjects(params: Rekognition.Types.DescribeProjectsRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectsResponse) => void): Request<Rekognition.Types.DescribeProjectsResponse, AWSError>;
115 /**
116 * Lists and gets information about your Amazon Rekognition Custom Labels projects. This operation requires permissions to perform the rekognition:DescribeProjects action.
117 */
118 describeProjects(callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectsResponse) => void): Request<Rekognition.Types.DescribeProjectsResponse, AWSError>;
119 /**
120 * 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.
121 */
122 describeStreamProcessor(params: Rekognition.Types.DescribeStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request<Rekognition.Types.DescribeStreamProcessorResponse, AWSError>;
123 /**
124 * 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.
125 */
126 describeStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request<Rekognition.Types.DescribeStreamProcessorResponse, AWSError>;
127 /**
128 * 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.
129 */
130 detectCustomLabels(params: Rekognition.Types.DetectCustomLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectCustomLabelsResponse) => void): Request<Rekognition.Types.DetectCustomLabelsResponse, AWSError>;
131 /**
132 * 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.
133 */
134 detectCustomLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectCustomLabelsResponse) => void): Request<Rekognition.Types.DetectCustomLabelsResponse, AWSError>;
135 /**
136 * 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 AWS CLI 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.
137 */
138 detectFaces(params: Rekognition.Types.DetectFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request<Rekognition.Types.DetectFacesResponse, AWSError>;
139 /**
140 * 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 AWS CLI 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.
141 */
142 detectFaces(callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request<Rekognition.Types.DetectFacesResponse, AWSError>;
143 /**
144 * Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide. DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. 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, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. {Name: lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name: sea,Confidence: 75.061} In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. {Name: flower,Confidence: 99.0562} {Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more precisely identifies the flower as a tulip. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectLabels action.
145 */
146 detectLabels(params: Rekognition.Types.DetectLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request<Rekognition.Types.DetectLabelsResponse, AWSError>;
147 /**
148 * Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide. DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. 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, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. {Name: lighthouse, Confidence: 98.4629} {Name: rock,Confidence: 79.2097} {Name: sea,Confidence: 75.061} In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. {Name: flower,Confidence: 99.0562} {Name: plant,Confidence: 99.0562} {Name: tulip,Confidence: 99.0562} In this example, the detection algorithm more precisely identifies the flower as a tulip. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned. If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides. DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectLabels action.
149 */
150 detectLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request<Rekognition.Types.DetectLabelsResponse, AWSError>;
151 /**
152 * Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. 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.
153 */
154 detectModerationLabels(params: Rekognition.Types.DetectModerationLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request<Rekognition.Types.DetectModerationLabelsResponse, AWSError>;
155 /**
156 * Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate. For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. 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.
157 */
158 detectModerationLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request<Rekognition.Types.DetectModerationLabelsResponse, AWSError>;
159 /**
160 * Detects text in the input image and converts it into machine-readable text. 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, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide.
161 */
162 detectText(params: Rekognition.Types.DetectTextRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request<Rekognition.Types.DetectTextResponse, AWSError>;
163 /**
164 * Detects text in the input image and converts it into machine-readable text. 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, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image. A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image. A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines. To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field. To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. For more information, see DetectText in the Amazon Rekognition Developer Guide.
165 */
166 detectText(callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request<Rekognition.Types.DetectTextResponse, AWSError>;
167 /**
168 * Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:GetCelebrityInfo action.
169 */
170 getCelebrityInfo(params: Rekognition.Types.GetCelebrityInfoRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request<Rekognition.Types.GetCelebrityInfoResponse, AWSError>;
171 /**
172 * Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:GetCelebrityInfo action.
173 */
174 getCelebrityInfo(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request<Rekognition.Types.GetCelebrityInfoResponse, AWSError>;
175 /**
176 * Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer. No information is returned for faces not recognized as celebrities. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.
177 */
178 getCelebrityRecognition(params: Rekognition.Types.GetCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request<Rekognition.Types.GetCelebrityRecognitionResponse, AWSError>;
179 /**
180 * Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition. Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection. For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter. The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer. No information is returned for faces not recognized as celebrities. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.
181 */
182 getCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request<Rekognition.Types.GetCelebrityRecognitionResponse, AWSError>;
183 /**
184 * Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns detected unsafe content labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter. Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
185 */
186 getContentModeration(params: Rekognition.Types.GetContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request<Rekognition.Types.GetContentModerationResponse, AWSError>;
187 /**
188 * Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. GetContentModeration returns detected unsafe content labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects. By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter. Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
189 */
190 getContentModeration(callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request<Rekognition.Types.GetContentModerationResponse, AWSError>;
191 /**
192 * Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.
193 */
194 getFaceDetection(params: Rekognition.Types.GetFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request<Rekognition.Types.GetFaceDetectionResponse, AWSError>;
195 /**
196 * Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection. Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.
197 */
198 getFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request<Rekognition.Types.GetFaceDetectionResponse, AWSError>;
199 /**
200 * Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.
201 */
202 getFaceSearch(params: Rekognition.Types.GetFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request<Rekognition.Types.GetFaceSearchResponse, AWSError>;
203 /**
204 * Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.
205 */
206 getFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request<Rekognition.Types.GetFaceSearchResponse, AWSError>;
207 /**
208 * Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.
209 */
210 getLabelDetection(params: Rekognition.Types.GetLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request<Rekognition.Types.GetLabelDetectionResponse, AWSError>;
211 /**
212 * Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection. The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection. GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter. The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.
213 */
214 getLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request<Rekognition.Types.GetLabelDetectionResponse, AWSError>;
215 /**
216 * Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking. The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking. To get the results of the person path tracking 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. GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video. GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter. Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.
217 */
218 getPersonTracking(params: Rekognition.Types.GetPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request<Rekognition.Types.GetPersonTrackingResponse, AWSError>;
219 /**
220 * Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking. The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking. To get the results of the person path tracking 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. GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video. GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter. Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.
221 */
222 getPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request<Rekognition.Types.GetPersonTrackingResponse, AWSError>;
223 /**
224 * Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection. Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection. GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video. Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines. Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.
225 */
226 getTextDetection(params: Rekognition.Types.GetTextDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetTextDetectionResponse) => void): Request<Rekognition.Types.GetTextDetectionResponse, AWSError>;
227 /**
228 * Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection. Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection. GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video. Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines. Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.
229 */
230 getTextDetection(callback?: (err: AWSError, data: Rekognition.Types.GetTextDetectionResponse) => void): Request<Rekognition.Types.GetTextDetectionResponse, AWSError>;
231 /**
232 * Detects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations. For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide. To get the number of faces in a collection, call DescribeCollection. If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field. To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces For more information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. 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. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify 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. Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as: The number of faces detected exceeds the value of the MaxFaces request parameter. The face is too small compared to the image dimensions. The face is too blurry. The image is too dark. The face has an extreme pose. The face doesn’t have enough detail to be suitable for face search. In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes: The bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which indicates the confidence that the bounding box contains a face. A face ID, FaceId, assigned by the service for each face that's detected and stored. An image ID, ImageId, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is passed 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 isn't supported. The image must be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action.
233 */
234 indexFaces(params: Rekognition.Types.IndexFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request<Rekognition.Types.IndexFacesResponse, AWSError>;
235 /**
236 * Detects faces in the input image and adds them to the specified collection. Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations. For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide. To get the number of faces in a collection, call DescribeCollection. If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field. To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces For more information, see Model Versioning in the Amazon Rekognition Developer Guide. If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. 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. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify 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. Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as: The number of faces detected exceeds the value of the MaxFaces request parameter. The face is too small compared to the image dimensions. The face is too blurry. The image is too dark. The face has an extreme pose. The face doesn’t have enough detail to be suitable for face search. In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes: The bounding box, BoundingBox, of the detected face. A confidence value, Confidence, which indicates the confidence that the bounding box contains a face. A face ID, FaceId, assigned by the service for each face that's detected and stored. An image ID, ImageId, assigned by the service for the input image. If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata. The input image is passed 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 isn't supported. The image must be formatted as a PNG or JPEG file. This operation requires permissions to perform the rekognition:IndexFaces action.
237 */
238 indexFaces(callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request<Rekognition.Types.IndexFacesResponse, AWSError>;
239 /**
240 * Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see Listing Collections in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListCollections action.
241 */
242 listCollections(params: Rekognition.Types.ListCollectionsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request<Rekognition.Types.ListCollectionsResponse, AWSError>;
243 /**
244 * Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs. For an example, see Listing Collections in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListCollections action.
245 */
246 listCollections(callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request<Rekognition.Types.ListCollectionsResponse, AWSError>;
247 /**
248 * Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListFaces action.
249 */
250 listFaces(params: Rekognition.Types.ListFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request<Rekognition.Types.ListFacesResponse, AWSError>;
251 /**
252 * Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:ListFaces action.
253 */
254 listFaces(callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request<Rekognition.Types.ListFacesResponse, AWSError>;
255 /**
256 * Gets a list of stream processors that you have created with CreateStreamProcessor.
257 */
258 listStreamProcessors(params: Rekognition.Types.ListStreamProcessorsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
259 /**
260 * Gets a list of stream processors that you have created with CreateStreamProcessor.
261 */
262 listStreamProcessors(callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
263 /**
264 * Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo 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. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
265 */
266 recognizeCelebrities(params: Rekognition.Types.RecognizeCelebritiesRequest, callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
267 /**
268 * Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 faces in the image. For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image. Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo 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. For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
269 */
270 recognizeCelebrities(callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
271 /**
272 * For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation 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 that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action.
273 */
274 searchFaces(params: Rekognition.Types.SearchFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request<Rekognition.Types.SearchFacesResponse, AWSError>;
275 /**
276 * For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection. You can also search faces without indexing faces by using the SearchFacesByImage operation. The operation 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 that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face. For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFaces action.
277 */
278 searchFaces(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request<Rekognition.Types.SearchFacesResponse, AWSError>;
279 /**
280 * 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.
281 */
282 searchFacesByImage(params: Rekognition.Types.SearchFacesByImageRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
283 /**
284 * 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.
285 */
286 searchFacesByImage(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
287 /**
288 * Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
289 */
290 startCelebrityRecognition(params: Rekognition.Types.StartCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request<Rekognition.Types.StartCelebrityRecognitionResponse, AWSError>;
291 /**
292 * Starts asynchronous recognition of celebrities in a stored video. Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.
293 */
294 startCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request<Rekognition.Types.StartCelebrityRecognitionResponse, AWSError>;
295 /**
296 * Starts asynchronous detection of unsafe content in a stored video. Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
297 */
298 startContentModeration(params: Rekognition.Types.StartContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request<Rekognition.Types.StartContentModerationResponse, AWSError>;
299 /**
300 * Starts asynchronous detection of unsafe content in a stored video. Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
301 */
302 startContentModeration(callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request<Rekognition.Types.StartContentModerationResponse, AWSError>;
303 /**
304 * Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
305 */
306 startFaceDetection(params: Rekognition.Types.StartFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request<Rekognition.Types.StartFaceDetectionResponse, AWSError>;
307 /**
308 * Starts asynchronous detection of faces in a stored video. Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection. For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.
309 */
310 startFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request<Rekognition.Types.StartFaceDetectionResponse, AWSError>;
311 /**
312 * Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.
313 */
314 startFaceSearch(params: Rekognition.Types.StartFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request<Rekognition.Types.StartFaceSearchResponse, AWSError>;
315 /**
316 * Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.
317 */
318 startFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request<Rekognition.Types.StartFaceSearchResponse, AWSError>;
319 /**
320 * Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.
321 */
322 startLabelDetection(params: Rekognition.Types.StartLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request<Rekognition.Types.StartLabelDetectionResponse, AWSError>;
323 /**
324 * Starts asynchronous detection of labels in a stored video. Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.
325 */
326 startLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request<Rekognition.Types.StartLabelDetectionResponse, AWSError>;
327 /**
328 * 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.
329 */
330 startPersonTracking(params: Rekognition.Types.StartPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request<Rekognition.Types.StartPersonTrackingResponse, AWSError>;
331 /**
332 * 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.
333 */
334 startPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request<Rekognition.Types.StartPersonTrackingResponse, AWSError>;
335 /**
336 * 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.
337 */
338 startProjectVersion(params: Rekognition.Types.StartProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartProjectVersionResponse) => void): Request<Rekognition.Types.StartProjectVersionResponse, AWSError>;
339 /**
340 * 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.
341 */
342 startProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.StartProjectVersionResponse) => void): Request<Rekognition.Types.StartProjectVersionResponse, AWSError>;
343 /**
344 * 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.
345 */
346 startStreamProcessor(params: Rekognition.Types.StartStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request<Rekognition.Types.StartStreamProcessorResponse, AWSError>;
347 /**
348 * 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.
349 */
350 startStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request<Rekognition.Types.StartStreamProcessorResponse, AWSError>;
351 /**
352 * Starts asynchronous detection of text in a stored video. Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.
353 */
354 startTextDetection(params: Rekognition.Types.StartTextDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartTextDetectionResponse) => void): Request<Rekognition.Types.StartTextDetectionResponse, AWSError>;
355 /**
356 * Starts asynchronous detection of text in a stored video. Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.
357 */
358 startTextDetection(callback?: (err: AWSError, data: Rekognition.Types.StartTextDetectionResponse) => void): Request<Rekognition.Types.StartTextDetectionResponse, AWSError>;
359 /**
360 * Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.
361 */
362 stopProjectVersion(params: Rekognition.Types.StopProjectVersionRequest, callback?: (err: AWSError, data: Rekognition.Types.StopProjectVersionResponse) => void): Request<Rekognition.Types.StopProjectVersionResponse, AWSError>;
363 /**
364 * Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.
365 */
366 stopProjectVersion(callback?: (err: AWSError, data: Rekognition.Types.StopProjectVersionResponse) => void): Request<Rekognition.Types.StopProjectVersionResponse, AWSError>;
367 /**
368 * Stops a running stream processor that was created by CreateStreamProcessor.
369 */
370 stopStreamProcessor(params: Rekognition.Types.StopStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
371 /**
372 * Stops a running stream processor that was created by CreateStreamProcessor.
373 */
374 stopStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
375 /**
376 * 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.
377 */
378 waitFor(state: "projectVersionTrainingCompleted", params: Rekognition.Types.DescribeProjectVersionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
379 /**
380 * 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.
381 */
382 waitFor(state: "projectVersionTrainingCompleted", callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
383 /**
384 * 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.
385 */
386 waitFor(state: "projectVersionRunning", params: Rekognition.Types.DescribeProjectVersionsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
387 /**
388 * 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.
389 */
390 waitFor(state: "projectVersionRunning", callback?: (err: AWSError, data: Rekognition.Types.DescribeProjectVersionsResponse) => void): Request<Rekognition.Types.DescribeProjectVersionsResponse, AWSError>;
391}
392declare namespace Rekognition {
393 export interface AgeRange {
394 /**
395 * The lowest estimated age.
396 */
397 Low?: UInteger;
398 /**
399 * The highest estimated age.
400 */
401 High?: UInteger;
402 }
403 export interface Asset {
404 GroundTruthManifest?: GroundTruthManifest;
405 }
406 export type Assets = Asset[];
407 export type Attribute = "DEFAULT"|"ALL"|string;
408 export type Attributes = Attribute[];
409 export interface Beard {
410 /**
411 * Boolean value that indicates whether the face has beard or not.
412 */
413 Value?: Boolean;
414 /**
415 * Level of confidence in the determination.
416 */
417 Confidence?: Percent;
418 }
419 export type Boolean = boolean;
420 export interface BoundingBox {
421 /**
422 * Width of the bounding box as a ratio of the overall image width.
423 */
424 Width?: Float;
425 /**
426 * Height of the bounding box as a ratio of the overall image height.
427 */
428 Height?: Float;
429 /**
430 * Left coordinate of the bounding box as a ratio of overall image width.
431 */
432 Left?: Float;
433 /**
434 * Top coordinate of the bounding box as a ratio of overall image height.
435 */
436 Top?: Float;
437 }
438 export type BoundingBoxHeight = number;
439 export type BoundingBoxWidth = number;
440 export interface Celebrity {
441 /**
442 * An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
443 */
444 Urls?: Urls;
445 /**
446 * The name of the celebrity.
447 */
448 Name?: String;
449 /**
450 * A unique identifier for the celebrity.
451 */
452 Id?: RekognitionUniqueId;
453 /**
454 * Provides information about the celebrity's face, such as its location on the image.
455 */
456 Face?: ComparedFace;
457 /**
458 * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
459 */
460 MatchConfidence?: Percent;
461 }
462 export interface CelebrityDetail {
463 /**
464 * An array of URLs pointing to additional celebrity information.
465 */
466 Urls?: Urls;
467 /**
468 * The name of the celebrity.
469 */
470 Name?: String;
471 /**
472 * The unique identifier for the celebrity.
473 */
474 Id?: RekognitionUniqueId;
475 /**
476 * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
477 */
478 Confidence?: Percent;
479 /**
480 * Bounding box around the body of a celebrity.
481 */
482 BoundingBox?: BoundingBox;
483 /**
484 * Face details for the recognized celebrity.
485 */
486 Face?: FaceDetail;
487 }
488 export type CelebrityList = Celebrity[];
489 export interface CelebrityRecognition {
490 /**
491 * The time, in milliseconds from the start of the video, that the celebrity was recognized.
492 */
493 Timestamp?: Timestamp;
494 /**
495 * Information about a recognized celebrity.
496 */
497 Celebrity?: CelebrityDetail;
498 }
499 export type CelebrityRecognitionSortBy = "ID"|"TIMESTAMP"|string;
500 export type CelebrityRecognitions = CelebrityRecognition[];
501 export type ClientRequestToken = string;
502 export type CollectionId = string;
503 export type CollectionIdList = CollectionId[];
504 export interface CompareFacesMatch {
505 /**
506 * Level of confidence that the faces match.
507 */
508 Similarity?: Percent;
509 /**
510 * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
511 */
512 Face?: ComparedFace;
513 }
514 export type CompareFacesMatchList = CompareFacesMatch[];
515 export interface CompareFacesRequest {
516 /**
517 * 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.
518 */
519 SourceImage: Image;
520 /**
521 * The target 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.
522 */
523 TargetImage: Image;
524 /**
525 * The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
526 */
527 SimilarityThreshold?: Percent;
528 /**
529 * 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.
530 */
531 QualityFilter?: QualityFilter;
532 }
533 export interface CompareFacesResponse {
534 /**
535 * The face in the source image that was used for comparison.
536 */
537 SourceImageFace?: ComparedSourceImageFace;
538 /**
539 * An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.
540 */
541 FaceMatches?: CompareFacesMatchList;
542 /**
543 * An array of faces in the target image that did not match the source image face.
544 */
545 UnmatchedFaces?: CompareFacesUnmatchList;
546 /**
547 * The value of SourceImageOrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
548 */
549 SourceImageOrientationCorrection?: OrientationCorrection;
550 /**
551 * The value of TargetImageOrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
552 */
553 TargetImageOrientationCorrection?: OrientationCorrection;
554 }
555 export type CompareFacesUnmatchList = ComparedFace[];
556 export interface ComparedFace {
557 /**
558 * Bounding box of the face.
559 */
560 BoundingBox?: BoundingBox;
561 /**
562 * Level of confidence that what the bounding box contains is a face.
563 */
564 Confidence?: Percent;
565 /**
566 * An array of facial landmarks.
567 */
568 Landmarks?: Landmarks;
569 /**
570 * Indicates the pose of the face as determined by its pitch, roll, and yaw.
571 */
572 Pose?: Pose;
573 /**
574 * Identifies face image brightness and sharpness.
575 */
576 Quality?: ImageQuality;
577 }
578 export type ComparedFaceList = ComparedFace[];
579 export interface ComparedSourceImageFace {
580 /**
581 * Bounding box of the face.
582 */
583 BoundingBox?: BoundingBox;
584 /**
585 * Confidence level that the selected bounding box contains a face.
586 */
587 Confidence?: Percent;
588 }
589 export type ContentClassifier = "FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent"|string;
590 export type ContentClassifiers = ContentClassifier[];
591 export interface ContentModerationDetection {
592 /**
593 * Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.
594 */
595 Timestamp?: Timestamp;
596 /**
597 * The unsafe content label detected by in the stored video.
598 */
599 ModerationLabel?: ModerationLabel;
600 }
601 export type ContentModerationDetections = ContentModerationDetection[];
602 export type ContentModerationSortBy = "NAME"|"TIMESTAMP"|string;
603 export interface CreateCollectionRequest {
604 /**
605 * ID for the collection that you are creating.
606 */
607 CollectionId: CollectionId;
608 }
609 export interface CreateCollectionResponse {
610 /**
611 * HTTP status code indicating the result of the operation.
612 */
613 StatusCode?: UInteger;
614 /**
615 * Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
616 */
617 CollectionArn?: String;
618 /**
619 * Version number of the face detection model associated with the collection you are creating.
620 */
621 FaceModelVersion?: String;
622 }
623 export interface CreateProjectRequest {
624 /**
625 * The name of the project to create.
626 */
627 ProjectName: ProjectName;
628 }
629 export interface CreateProjectResponse {
630 /**
631 * The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.
632 */
633 ProjectArn?: ProjectArn;
634 }
635 export interface CreateProjectVersionRequest {
636 /**
637 * The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
638 */
639 ProjectArn: ProjectArn;
640 /**
641 * A name for the version of the model. This value must be unique.
642 */
643 VersionName: VersionName;
644 /**
645 * The Amazon S3 location to store the results of training.
646 */
647 OutputConfig: OutputConfig;
648 /**
649 * The dataset to use for training.
650 */
651 TrainingData: TrainingData;
652 /**
653 * The dataset to use for testing.
654 */
655 TestingData: TestingData;
656 }
657 export interface CreateProjectVersionResponse {
658 /**
659 * The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.
660 */
661 ProjectVersionArn?: ProjectVersionArn;
662 }
663 export interface CreateStreamProcessorRequest {
664 /**
665 * Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.
666 */
667 Input: StreamProcessorInput;
668 /**
669 * Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.
670 */
671 Output: StreamProcessorOutput;
672 /**
673 * An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent.
674 */
675 Name: StreamProcessorName;
676 /**
677 * Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
678 */
679 Settings: StreamProcessorSettings;
680 /**
681 * ARN of the IAM role that allows access to the stream processor.
682 */
683 RoleArn: RoleArn;
684 }
685 export interface CreateStreamProcessorResponse {
686 /**
687 * ARN for the newly create stream processor.
688 */
689 StreamProcessorArn?: StreamProcessorArn;
690 }
691 export interface CustomLabel {
692 /**
693 * The name of the custom label.
694 */
695 Name?: String;
696 /**
697 * 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.
698 */
699 Confidence?: Percent;
700 /**
701 * 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.
702 */
703 Geometry?: Geometry;
704 }
705 export type CustomLabels = CustomLabel[];
706 export type DateTime = Date;
707 export type Degree = number;
708 export interface DeleteCollectionRequest {
709 /**
710 * ID of the collection to delete.
711 */
712 CollectionId: CollectionId;
713 }
714 export interface DeleteCollectionResponse {
715 /**
716 * HTTP status code that indicates the result of the operation.
717 */
718 StatusCode?: UInteger;
719 }
720 export interface DeleteFacesRequest {
721 /**
722 * Collection from which to remove the specific faces.
723 */
724 CollectionId: CollectionId;
725 /**
726 * An array of face IDs to delete.
727 */
728 FaceIds: FaceIdList;
729 }
730 export interface DeleteFacesResponse {
731 /**
732 * An array of strings (face IDs) of the faces that were deleted.
733 */
734 DeletedFaces?: FaceIdList;
735 }
736 export interface DeleteProjectRequest {
737 /**
738 * The Amazon Resource Name (ARN) of the project that you want to delete.
739 */
740 ProjectArn: ProjectArn;
741 }
742 export interface DeleteProjectResponse {
743 /**
744 * The current status of the delete project operation.
745 */
746 Status?: ProjectStatus;
747 }
748 export interface DeleteProjectVersionRequest {
749 /**
750 * The Amazon Resource Name (ARN) of the model version that you want to delete.
751 */
752 ProjectVersionArn: ProjectVersionArn;
753 }
754 export interface DeleteProjectVersionResponse {
755 /**
756 * The status of the deletion operation.
757 */
758 Status?: ProjectVersionStatus;
759 }
760 export interface DeleteStreamProcessorRequest {
761 /**
762 * The name of the stream processor you want to delete.
763 */
764 Name: StreamProcessorName;
765 }
766 export interface DeleteStreamProcessorResponse {
767 }
768 export interface DescribeCollectionRequest {
769 /**
770 * The ID of the collection to describe.
771 */
772 CollectionId: CollectionId;
773 }
774 export interface DescribeCollectionResponse {
775 /**
776 * The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
777 */
778 FaceCount?: ULong;
779 /**
780 * The version of the face model that's used by the collection for face detection. For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
781 */
782 FaceModelVersion?: String;
783 /**
784 * The Amazon Resource Name (ARN) of the collection.
785 */
786 CollectionARN?: String;
787 /**
788 * The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
789 */
790 CreationTimestamp?: DateTime;
791 }
792 export interface DescribeProjectVersionsRequest {
793 /**
794 * The Amazon Resource Name (ARN) of the project that contains the models you want to describe.
795 */
796 ProjectArn: ProjectArn;
797 /**
798 * 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.
799 */
800 VersionNames?: VersionNames;
801 /**
802 * 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.
803 */
804 NextToken?: ExtendedPaginationToken;
805 /**
806 * 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.
807 */
808 MaxResults?: ProjectVersionsPageSize;
809 }
810 export interface DescribeProjectVersionsResponse {
811 /**
812 * A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.
813 */
814 ProjectVersionDescriptions?: ProjectVersionDescriptions;
815 /**
816 * 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.
817 */
818 NextToken?: ExtendedPaginationToken;
819 }
820 export interface DescribeProjectsRequest {
821 /**
822 * 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.
823 */
824 NextToken?: ExtendedPaginationToken;
825 /**
826 * 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.
827 */
828 MaxResults?: ProjectsPageSize;
829 }
830 export interface DescribeProjectsResponse {
831 /**
832 * A list of project descriptions. The list is sorted by the date and time the projects are created.
833 */
834 ProjectDescriptions?: ProjectDescriptions;
835 /**
836 * 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.
837 */
838 NextToken?: ExtendedPaginationToken;
839 }
840 export interface DescribeStreamProcessorRequest {
841 /**
842 * Name of the stream processor for which you want information.
843 */
844 Name: StreamProcessorName;
845 }
846 export interface DescribeStreamProcessorResponse {
847 /**
848 * Name of the stream processor.
849 */
850 Name?: StreamProcessorName;
851 /**
852 * ARN of the stream processor.
853 */
854 StreamProcessorArn?: StreamProcessorArn;
855 /**
856 * Current status of the stream processor.
857 */
858 Status?: StreamProcessorStatus;
859 /**
860 * Detailed status message about the stream processor.
861 */
862 StatusMessage?: String;
863 /**
864 * Date and time the stream processor was created
865 */
866 CreationTimestamp?: DateTime;
867 /**
868 * The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.
869 */
870 LastUpdateTimestamp?: DateTime;
871 /**
872 * Kinesis video stream that provides the source streaming video.
873 */
874 Input?: StreamProcessorInput;
875 /**
876 * Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
877 */
878 Output?: StreamProcessorOutput;
879 /**
880 * ARN of the IAM role that allows access to the stream processor.
881 */
882 RoleArn?: RoleArn;
883 /**
884 * Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
885 */
886 Settings?: StreamProcessorSettings;
887 }
888 export interface DetectCustomLabelsRequest {
889 /**
890 * The ARN of the model version that you want to use.
891 */
892 ProjectVersionArn: ProjectVersionArn;
893 Image: Image;
894 /**
895 * 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.
896 */
897 MaxResults?: UInteger;
898 /**
899 * 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.
900 */
901 MinConfidence?: Percent;
902 }
903 export interface DetectCustomLabelsResponse {
904 /**
905 * An array of custom labels detected in the input image.
906 */
907 CustomLabels?: CustomLabels;
908 }
909 export interface DetectFacesRequest {
910 /**
911 * 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.
912 */
913 Image: Image;
914 /**
915 * An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
916 */
917 Attributes?: Attributes;
918 }
919 export interface DetectFacesResponse {
920 /**
921 * Details of each face found in the image.
922 */
923 FaceDetails?: FaceDetailList;
924 /**
925 * The value of OrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
926 */
927 OrientationCorrection?: OrientationCorrection;
928 }
929 export interface DetectLabelsRequest {
930 /**
931 * The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded. 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.
932 */
933 Image: Image;
934 /**
935 * Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
936 */
937 MaxLabels?: UInteger;
938 /**
939 * Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value. If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.
940 */
941 MinConfidence?: Percent;
942 }
943 export interface DetectLabelsResponse {
944 /**
945 * An array of labels for the real-world objects detected.
946 */
947 Labels?: Labels;
948 /**
949 * The value of OrientationCorrection is always null. If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
950 */
951 OrientationCorrection?: OrientationCorrection;
952 /**
953 * Version number of the label detection model that was used to detect labels.
954 */
955 LabelModelVersion?: String;
956 }
957 export interface DetectModerationLabelsRequest {
958 /**
959 * 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.
960 */
961 Image: Image;
962 /**
963 * 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.
964 */
965 MinConfidence?: Percent;
966 /**
967 * Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.
968 */
969 HumanLoopConfig?: HumanLoopConfig;
970 }
971 export interface DetectModerationLabelsResponse {
972 /**
973 * Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.
974 */
975 ModerationLabels?: ModerationLabels;
976 /**
977 * Version number of the moderation detection model that was used to detect unsafe content.
978 */
979 ModerationModelVersion?: String;
980 /**
981 * Shows the results of the human in the loop evaluation.
982 */
983 HumanLoopActivationOutput?: HumanLoopActivationOutput;
984 }
985 export interface DetectTextFilters {
986 WordFilter?: DetectionFilter;
987 /**
988 * A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the image.
989 */
990 RegionsOfInterest?: RegionsOfInterest;
991 }
992 export interface DetectTextRequest {
993 /**
994 * The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. 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.
995 */
996 Image: Image;
997 /**
998 * Optional parameters that let you set the criteria that the text must meet to be included in your response.
999 */
1000 Filters?: DetectTextFilters;
1001 }
1002 export interface DetectTextResponse {
1003 /**
1004 * An array of text that was detected in the input image.
1005 */
1006 TextDetections?: TextDetectionList;
1007 /**
1008 * The model version used to detect text.
1009 */
1010 TextModelVersion?: String;
1011 }
1012 export interface DetectionFilter {
1013 /**
1014 * Sets confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0.5 and 1 as Text in Video will not return any result below 0.5.
1015 */
1016 MinConfidence?: Percent;
1017 /**
1018 * Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.
1019 */
1020 MinBoundingBoxHeight?: BoundingBoxHeight;
1021 /**
1022 * Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.
1023 */
1024 MinBoundingBoxWidth?: BoundingBoxWidth;
1025 }
1026 export interface Emotion {
1027 /**
1028 * Type of emotion detected.
1029 */
1030 Type?: EmotionName;
1031 /**
1032 * Level of confidence in the determination.
1033 */
1034 Confidence?: Percent;
1035 }
1036 export type EmotionName = "HAPPY"|"SAD"|"ANGRY"|"CONFUSED"|"DISGUSTED"|"SURPRISED"|"CALM"|"UNKNOWN"|"FEAR"|string;
1037 export type Emotions = Emotion[];
1038 export interface EvaluationResult {
1039 /**
1040 * 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.
1041 */
1042 F1Score?: Float;
1043 /**
1044 * The S3 bucket that contains the training summary.
1045 */
1046 Summary?: Summary;
1047 }
1048 export type ExtendedPaginationToken = string;
1049 export type ExternalImageId = string;
1050 export interface EyeOpen {
1051 /**
1052 * Boolean value that indicates whether the eyes on the face are open.
1053 */
1054 Value?: Boolean;
1055 /**
1056 * Level of confidence in the determination.
1057 */
1058 Confidence?: Percent;
1059 }
1060 export interface Eyeglasses {
1061 /**
1062 * Boolean value that indicates whether the face is wearing eye glasses or not.
1063 */
1064 Value?: Boolean;
1065 /**
1066 * Level of confidence in the determination.
1067 */
1068 Confidence?: Percent;
1069 }
1070 export interface Face {
1071 /**
1072 * Unique identifier that Amazon Rekognition assigns to the face.
1073 */
1074 FaceId?: FaceId;
1075 /**
1076 * Bounding box of the face.
1077 */
1078 BoundingBox?: BoundingBox;
1079 /**
1080 * Unique identifier that Amazon Rekognition assigns to the input image.
1081 */
1082 ImageId?: ImageId;
1083 /**
1084 * Identifier that you assign to all the faces in the input image.
1085 */
1086 ExternalImageId?: ExternalImageId;
1087 /**
1088 * Confidence level that the bounding box contains a face (and not a different object such as a tree).
1089 */
1090 Confidence?: Percent;
1091 }
1092 export type FaceAttributes = "DEFAULT"|"ALL"|string;
1093 export interface FaceDetail {
1094 /**
1095 * Bounding box of the face. Default attribute.
1096 */
1097 BoundingBox?: BoundingBox;
1098 /**
1099 * The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
1100 */
1101 AgeRange?: AgeRange;
1102 /**
1103 * Indicates whether or not the face is smiling, and the confidence level in the determination.
1104 */
1105 Smile?: Smile;
1106 /**
1107 * Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
1108 */
1109 Eyeglasses?: Eyeglasses;
1110 /**
1111 * Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
1112 */
1113 Sunglasses?: Sunglasses;
1114 /**
1115 * The predicted gender of a detected face.
1116 */
1117 Gender?: Gender;
1118 /**
1119 * Indicates whether or not the face has a beard, and the confidence level in the determination.
1120 */
1121 Beard?: Beard;
1122 /**
1123 * Indicates whether or not the face has a mustache, and the confidence level in the determination.
1124 */
1125 Mustache?: Mustache;
1126 /**
1127 * Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
1128 */
1129 EyesOpen?: EyeOpen;
1130 /**
1131 * Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
1132 */
1133 MouthOpen?: MouthOpen;
1134 /**
1135 * The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
1136 */
1137 Emotions?: Emotions;
1138 /**
1139 * Indicates the location of landmarks on the face. Default attribute.
1140 */
1141 Landmarks?: Landmarks;
1142 /**
1143 * Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
1144 */
1145 Pose?: Pose;
1146 /**
1147 * Identifies image brightness and sharpness. Default attribute.
1148 */
1149 Quality?: ImageQuality;
1150 /**
1151 * Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
1152 */
1153 Confidence?: Percent;
1154 }
1155 export type FaceDetailList = FaceDetail[];
1156 export interface FaceDetection {
1157 /**
1158 * Time, in milliseconds from the start of the video, that the face was detected.
1159 */
1160 Timestamp?: Timestamp;
1161 /**
1162 * The face properties for the detected face.
1163 */
1164 Face?: FaceDetail;
1165 }
1166 export type FaceDetections = FaceDetection[];
1167 export type FaceId = string;
1168 export type FaceIdList = FaceId[];
1169 export type FaceList = Face[];
1170 export interface FaceMatch {
1171 /**
1172 * Confidence in the match of this face with the input face.
1173 */
1174 Similarity?: Percent;
1175 /**
1176 * Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
1177 */
1178 Face?: Face;
1179 }
1180 export type FaceMatchList = FaceMatch[];
1181 export type FaceModelVersionList = String[];
1182 export interface FaceRecord {
1183 /**
1184 * Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
1185 */
1186 Face?: Face;
1187 /**
1188 * Structure containing attributes of the face that the algorithm detected.
1189 */
1190 FaceDetail?: FaceDetail;
1191 }
1192 export type FaceRecordList = FaceRecord[];
1193 export interface FaceSearchSettings {
1194 /**
1195 * The ID of a collection that contains faces that you want to search for.
1196 */
1197 CollectionId?: CollectionId;
1198 /**
1199 * Minimum face match confidence score that must be met to return a result for a recognized face. Default is 80. 0 is the lowest confidence. 100 is the highest confidence.
1200 */
1201 FaceMatchThreshold?: Percent;
1202 }
1203 export type FaceSearchSortBy = "INDEX"|"TIMESTAMP"|string;
1204 export type Float = number;
1205 export type FlowDefinitionArn = string;
1206 export interface Gender {
1207 /**
1208 * The predicted gender of the face.
1209 */
1210 Value?: GenderType;
1211 /**
1212 * Level of confidence in the prediction.
1213 */
1214 Confidence?: Percent;
1215 }
1216 export type GenderType = "Male"|"Female"|string;
1217 export interface Geometry {
1218 /**
1219 * An axis-aligned coarse representation of the detected item's location on the image.
1220 */
1221 BoundingBox?: BoundingBox;
1222 /**
1223 * Within the bounding box, a fine-grained polygon around the detected item.
1224 */
1225 Polygon?: Polygon;
1226 }
1227 export interface GetCelebrityInfoRequest {
1228 /**
1229 * The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
1230 */
1231 Id: RekognitionUniqueId;
1232 }
1233 export interface GetCelebrityInfoResponse {
1234 /**
1235 * An array of URLs pointing to additional celebrity information.
1236 */
1237 Urls?: Urls;
1238 /**
1239 * The name of the celebrity.
1240 */
1241 Name?: String;
1242 }
1243 export interface GetCelebrityRecognitionRequest {
1244 /**
1245 * Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.
1246 */
1247 JobId: JobId;
1248 /**
1249 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1250 */
1251 MaxResults?: MaxResults;
1252 /**
1253 * If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
1254 */
1255 NextToken?: PaginationToken;
1256 /**
1257 * Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.
1258 */
1259 SortBy?: CelebrityRecognitionSortBy;
1260 }
1261 export interface GetCelebrityRecognitionResponse {
1262 /**
1263 * The current status of the celebrity recognition job.
1264 */
1265 JobStatus?: VideoJobStatus;
1266 /**
1267 * If the job fails, StatusMessage provides a descriptive error message.
1268 */
1269 StatusMessage?: StatusMessage;
1270 /**
1271 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
1272 */
1273 VideoMetadata?: VideoMetadata;
1274 /**
1275 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
1276 */
1277 NextToken?: PaginationToken;
1278 /**
1279 * Array of celebrities recognized in the video.
1280 */
1281 Celebrities?: CelebrityRecognitions;
1282 }
1283 export interface GetContentModerationRequest {
1284 /**
1285 * The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.
1286 */
1287 JobId: JobId;
1288 /**
1289 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1290 */
1291 MaxResults?: MaxResults;
1292 /**
1293 * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of unsafe content labels.
1294 */
1295 NextToken?: PaginationToken;
1296 /**
1297 * Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.
1298 */
1299 SortBy?: ContentModerationSortBy;
1300 }
1301 export interface GetContentModerationResponse {
1302 /**
1303 * The current status of the unsafe content analysis job.
1304 */
1305 JobStatus?: VideoJobStatus;
1306 /**
1307 * If the job fails, StatusMessage provides a descriptive error message.
1308 */
1309 StatusMessage?: StatusMessage;
1310 /**
1311 * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.
1312 */
1313 VideoMetadata?: VideoMetadata;
1314 /**
1315 * The detected unsafe content labels and the time(s) they were detected.
1316 */
1317 ModerationLabels?: ContentModerationDetections;
1318 /**
1319 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of unsafe content labels.
1320 */
1321 NextToken?: PaginationToken;
1322 /**
1323 * Version number of the moderation detection model that was used to detect unsafe content.
1324 */
1325 ModerationModelVersion?: String;
1326 }
1327 export interface GetFaceDetectionRequest {
1328 /**
1329 * Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.
1330 */
1331 JobId: JobId;
1332 /**
1333 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1334 */
1335 MaxResults?: MaxResults;
1336 /**
1337 * If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
1338 */
1339 NextToken?: PaginationToken;
1340 }
1341 export interface GetFaceDetectionResponse {
1342 /**
1343 * The current status of the face detection job.
1344 */
1345 JobStatus?: VideoJobStatus;
1346 /**
1347 * If the job fails, StatusMessage provides a descriptive error message.
1348 */
1349 StatusMessage?: StatusMessage;
1350 /**
1351 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
1352 */
1353 VideoMetadata?: VideoMetadata;
1354 /**
1355 * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
1356 */
1357 NextToken?: PaginationToken;
1358 /**
1359 * An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
1360 */
1361 Faces?: FaceDetections;
1362 }
1363 export interface GetFaceSearchRequest {
1364 /**
1365 * The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.
1366 */
1367 JobId: JobId;
1368 /**
1369 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1370 */
1371 MaxResults?: MaxResults;
1372 /**
1373 * If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
1374 */
1375 NextToken?: PaginationToken;
1376 /**
1377 * Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.
1378 */
1379 SortBy?: FaceSearchSortBy;
1380 }
1381 export interface GetFaceSearchResponse {
1382 /**
1383 * The current status of the face search job.
1384 */
1385 JobStatus?: VideoJobStatus;
1386 /**
1387 * If the job fails, StatusMessage provides a descriptive error message.
1388 */
1389 StatusMessage?: StatusMessage;
1390 /**
1391 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
1392 */
1393 NextToken?: PaginationToken;
1394 /**
1395 * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
1396 */
1397 VideoMetadata?: VideoMetadata;
1398 /**
1399 * An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.
1400 */
1401 Persons?: PersonMatches;
1402 }
1403 export interface GetLabelDetectionRequest {
1404 /**
1405 * Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.
1406 */
1407 JobId: JobId;
1408 /**
1409 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1410 */
1411 MaxResults?: MaxResults;
1412 /**
1413 * If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
1414 */
1415 NextToken?: PaginationToken;
1416 /**
1417 * Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.
1418 */
1419 SortBy?: LabelDetectionSortBy;
1420 }
1421 export interface GetLabelDetectionResponse {
1422 /**
1423 * The current status of the label detection job.
1424 */
1425 JobStatus?: VideoJobStatus;
1426 /**
1427 * If the job fails, StatusMessage provides a descriptive error message.
1428 */
1429 StatusMessage?: StatusMessage;
1430 /**
1431 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
1432 */
1433 VideoMetadata?: VideoMetadata;
1434 /**
1435 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
1436 */
1437 NextToken?: PaginationToken;
1438 /**
1439 * An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
1440 */
1441 Labels?: LabelDetections;
1442 /**
1443 * Version number of the label detection model that was used to detect labels.
1444 */
1445 LabelModelVersion?: String;
1446 }
1447 export interface GetPersonTrackingRequest {
1448 /**
1449 * The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.
1450 */
1451 JobId: JobId;
1452 /**
1453 * Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
1454 */
1455 MaxResults?: MaxResults;
1456 /**
1457 * If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
1458 */
1459 NextToken?: PaginationToken;
1460 /**
1461 * Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.
1462 */
1463 SortBy?: PersonTrackingSortBy;
1464 }
1465 export interface GetPersonTrackingResponse {
1466 /**
1467 * The current status of the person tracking job.
1468 */
1469 JobStatus?: VideoJobStatus;
1470 /**
1471 * If the job fails, StatusMessage provides a descriptive error message.
1472 */
1473 StatusMessage?: StatusMessage;
1474 /**
1475 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
1476 */
1477 VideoMetadata?: VideoMetadata;
1478 /**
1479 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
1480 */
1481 NextToken?: PaginationToken;
1482 /**
1483 * An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.
1484 */
1485 Persons?: PersonDetections;
1486 }
1487 export interface GetTextDetectionRequest {
1488 /**
1489 * Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.
1490 */
1491 JobId: JobId;
1492 /**
1493 * Maximum number of results to return per paginated call. The largest value you can specify is 1000.
1494 */
1495 MaxResults?: MaxResults;
1496 /**
1497 * If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
1498 */
1499 NextToken?: PaginationToken;
1500 }
1501 export interface GetTextDetectionResponse {
1502 /**
1503 * Current status of the text detection job.
1504 */
1505 JobStatus?: VideoJobStatus;
1506 /**
1507 * If the job fails, StatusMessage provides a descriptive error message.
1508 */
1509 StatusMessage?: StatusMessage;
1510 VideoMetadata?: VideoMetadata;
1511 /**
1512 * An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
1513 */
1514 TextDetections?: TextDetectionResults;
1515 /**
1516 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
1517 */
1518 NextToken?: PaginationToken;
1519 /**
1520 * Version number of the text detection model that was used to detect text.
1521 */
1522 TextModelVersion?: String;
1523 }
1524 export interface GroundTruthManifest {
1525 S3Object?: S3Object;
1526 }
1527 export type HumanLoopActivationConditionsEvaluationResults = string;
1528 export interface HumanLoopActivationOutput {
1529 /**
1530 * The Amazon Resource Name (ARN) of the HumanLoop created.
1531 */
1532 HumanLoopArn?: HumanLoopArn;
1533 /**
1534 * Shows if and why human review was needed.
1535 */
1536 HumanLoopActivationReasons?: HumanLoopActivationReasons;
1537 /**
1538 * Shows the result of condition evaluations, including those conditions which activated a human review.
1539 */
1540 HumanLoopActivationConditionsEvaluationResults?: HumanLoopActivationConditionsEvaluationResults;
1541 }
1542 export type HumanLoopActivationReason = string;
1543 export type HumanLoopActivationReasons = HumanLoopActivationReason[];
1544 export type HumanLoopArn = string;
1545 export interface HumanLoopConfig {
1546 /**
1547 * The name of the human review used for this image. This should be kept unique within a region.
1548 */
1549 HumanLoopName: HumanLoopName;
1550 /**
1551 * The Amazon Resource Name (ARN) of the flow definition.
1552 */
1553 FlowDefinitionArn: FlowDefinitionArn;
1554 /**
1555 * Sets attributes of the input data.
1556 */
1557 DataAttributes?: HumanLoopDataAttributes;
1558 }
1559 export interface HumanLoopDataAttributes {
1560 /**
1561 * Sets whether the input image is free of personally identifiable information.
1562 */
1563 ContentClassifiers?: ContentClassifiers;
1564 }
1565 export type HumanLoopName = string;
1566 export interface Image {
1567 /**
1568 * Blob of image bytes up to 5 MBs.
1569 */
1570 Bytes?: ImageBlob;
1571 /**
1572 * Identifies an S3 object as the image source.
1573 */
1574 S3Object?: S3Object;
1575 }
1576 export type ImageBlob = Buffer|Uint8Array|Blob|string;
1577 export type ImageId = string;
1578 export interface ImageQuality {
1579 /**
1580 * Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
1581 */
1582 Brightness?: Float;
1583 /**
1584 * Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
1585 */
1586 Sharpness?: Float;
1587 }
1588 export interface IndexFacesRequest {
1589 /**
1590 * The ID of an existing collection to which you want to add the faces that are detected in the input images.
1591 */
1592 CollectionId: CollectionId;
1593 /**
1594 * 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 isn't 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.
1595 */
1596 Image: Image;
1597 /**
1598 * The ID you want to assign to all the faces detected in the image.
1599 */
1600 ExternalImageId?: ExternalImageId;
1601 /**
1602 * An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide ["ALL"], all facial attributes are returned, but the operation takes longer to complete. If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
1603 */
1604 DetectionAttributes?: Attributes;
1605 /**
1606 * The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces. If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array. The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order. MaxFaces can be used with a collection associated with any version of the face model.
1607 */
1608 MaxFaces?: MaxFacesToIndex;
1609 /**
1610 * A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. 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 default value is AUTO. 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. To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
1611 */
1612 QualityFilter?: QualityFilter;
1613 }
1614 export interface IndexFacesResponse {
1615 /**
1616 * An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
1617 */
1618 FaceRecords?: FaceRecordList;
1619 /**
1620 * If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned. If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies: If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null. If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated. Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.
1621 */
1622 OrientationCorrection?: OrientationCorrection;
1623 /**
1624 * The version number of the face detection model that's associated with the input collection (CollectionId).
1625 */
1626 FaceModelVersion?: String;
1627 /**
1628 * An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.
1629 */
1630 UnindexedFaces?: UnindexedFaces;
1631 }
1632 export type InferenceUnits = number;
1633 export interface Instance {
1634 /**
1635 * The position of the label instance on the image.
1636 */
1637 BoundingBox?: BoundingBox;
1638 /**
1639 * The confidence that Amazon Rekognition has in the accuracy of the bounding box.
1640 */
1641 Confidence?: Percent;
1642 }
1643 export type Instances = Instance[];
1644 export type JobId = string;
1645 export type JobTag = string;
1646 export type KinesisDataArn = string;
1647 export interface KinesisDataStream {
1648 /**
1649 * ARN of the output Amazon Kinesis Data Streams stream.
1650 */
1651 Arn?: KinesisDataArn;
1652 }
1653 export type KinesisVideoArn = string;
1654 export interface KinesisVideoStream {
1655 /**
1656 * ARN of the Kinesis video stream stream that streams the source video.
1657 */
1658 Arn?: KinesisVideoArn;
1659 }
1660 export interface Label {
1661 /**
1662 * The name (label) of the object or scene.
1663 */
1664 Name?: String;
1665 /**
1666 * Level of confidence.
1667 */
1668 Confidence?: Percent;
1669 /**
1670 * If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
1671 */
1672 Instances?: Instances;
1673 /**
1674 * The parent labels for a label. The response includes all ancestor labels.
1675 */
1676 Parents?: Parents;
1677 }
1678 export interface LabelDetection {
1679 /**
1680 * Time, in milliseconds from the start of the video, that the label was detected.
1681 */
1682 Timestamp?: Timestamp;
1683 /**
1684 * Details about the detected label.
1685 */
1686 Label?: Label;
1687 }
1688 export type LabelDetectionSortBy = "NAME"|"TIMESTAMP"|string;
1689 export type LabelDetections = LabelDetection[];
1690 export type Labels = Label[];
1691 export interface Landmark {
1692 /**
1693 * Type of landmark.
1694 */
1695 Type?: LandmarkType;
1696 /**
1697 * The x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
1698 */
1699 X?: Float;
1700 /**
1701 * The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.
1702 */
1703 Y?: Float;
1704 }
1705 export type LandmarkType = "eyeLeft"|"eyeRight"|"nose"|"mouthLeft"|"mouthRight"|"leftEyeBrowLeft"|"leftEyeBrowRight"|"leftEyeBrowUp"|"rightEyeBrowLeft"|"rightEyeBrowRight"|"rightEyeBrowUp"|"leftEyeLeft"|"leftEyeRight"|"leftEyeUp"|"leftEyeDown"|"rightEyeLeft"|"rightEyeRight"|"rightEyeUp"|"rightEyeDown"|"noseLeft"|"noseRight"|"mouthUp"|"mouthDown"|"leftPupil"|"rightPupil"|"upperJawlineLeft"|"midJawlineLeft"|"chinBottom"|"midJawlineRight"|"upperJawlineRight"|string;
1706 export type Landmarks = Landmark[];
1707 export interface ListCollectionsRequest {
1708 /**
1709 * Pagination token from the previous response.
1710 */
1711 NextToken?: PaginationToken;
1712 /**
1713 * Maximum number of collection IDs to return.
1714 */
1715 MaxResults?: PageSize;
1716 }
1717 export interface ListCollectionsResponse {
1718 /**
1719 * An array of collection IDs.
1720 */
1721 CollectionIds?: CollectionIdList;
1722 /**
1723 * If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.
1724 */
1725 NextToken?: PaginationToken;
1726 /**
1727 * Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].
1728 */
1729 FaceModelVersions?: FaceModelVersionList;
1730 }
1731 export interface ListFacesRequest {
1732 /**
1733 * ID of the collection from which to list the faces.
1734 */
1735 CollectionId: CollectionId;
1736 /**
1737 * If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
1738 */
1739 NextToken?: PaginationToken;
1740 /**
1741 * Maximum number of faces to return.
1742 */
1743 MaxResults?: PageSize;
1744 }
1745 export interface ListFacesResponse {
1746 /**
1747 * An array of Face objects.
1748 */
1749 Faces?: FaceList;
1750 /**
1751 * If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
1752 */
1753 NextToken?: String;
1754 /**
1755 * Version number of the face detection model associated with the input collection (CollectionId).
1756 */
1757 FaceModelVersion?: String;
1758 }
1759 export interface ListStreamProcessorsRequest {
1760 /**
1761 * If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.
1762 */
1763 NextToken?: PaginationToken;
1764 /**
1765 * Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
1766 */
1767 MaxResults?: MaxResults;
1768 }
1769 export interface ListStreamProcessorsResponse {
1770 /**
1771 * If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.
1772 */
1773 NextToken?: PaginationToken;
1774 /**
1775 * List of stream processors that you have created.
1776 */
1777 StreamProcessors?: StreamProcessorList;
1778 }
1779 export type MaxFaces = number;
1780 export type MaxFacesToIndex = number;
1781 export type MaxResults = number;
1782 export interface ModerationLabel {
1783 /**
1784 * Specifies the confidence that Amazon Rekognition has that the label has been correctly identified. If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent.
1785 */
1786 Confidence?: Percent;
1787 /**
1788 * The label name for the type of unsafe content detected in the image.
1789 */
1790 Name?: String;
1791 /**
1792 * The name for the parent label. Labels at the top level of the hierarchy have the parent label "".
1793 */
1794 ParentName?: String;
1795 }
1796 export type ModerationLabels = ModerationLabel[];
1797 export interface MouthOpen {
1798 /**
1799 * Boolean value that indicates whether the mouth on the face is open or not.
1800 */
1801 Value?: Boolean;
1802 /**
1803 * Level of confidence in the determination.
1804 */
1805 Confidence?: Percent;
1806 }
1807 export interface Mustache {
1808 /**
1809 * Boolean value that indicates whether the face has mustache or not.
1810 */
1811 Value?: Boolean;
1812 /**
1813 * Level of confidence in the determination.
1814 */
1815 Confidence?: Percent;
1816 }
1817 export interface NotificationChannel {
1818 /**
1819 * The Amazon SNS topic to which Amazon Rekognition to posts the completion status.
1820 */
1821 SNSTopicArn: SNSTopicArn;
1822 /**
1823 * The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.
1824 */
1825 RoleArn: RoleArn;
1826 }
1827 export type OrientationCorrection = "ROTATE_0"|"ROTATE_90"|"ROTATE_180"|"ROTATE_270"|string;
1828 export interface OutputConfig {
1829 /**
1830 * The S3 bucket where training output is placed.
1831 */
1832 S3Bucket?: S3Bucket;
1833 /**
1834 * The prefix applied to the training output files.
1835 */
1836 S3KeyPrefix?: S3KeyPrefix;
1837 }
1838 export type PageSize = number;
1839 export type PaginationToken = string;
1840 export interface Parent {
1841 /**
1842 * The name of the parent label.
1843 */
1844 Name?: String;
1845 }
1846 export type Parents = Parent[];
1847 export type Percent = number;
1848 export interface PersonDetail {
1849 /**
1850 * Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.
1851 */
1852 Index?: PersonIndex;
1853 /**
1854 * Bounding box around the detected person.
1855 */
1856 BoundingBox?: BoundingBox;
1857 /**
1858 * Face details for the detected person.
1859 */
1860 Face?: FaceDetail;
1861 }
1862 export interface PersonDetection {
1863 /**
1864 * The time, in milliseconds from the start of the video, that the person's path was tracked.
1865 */
1866 Timestamp?: Timestamp;
1867 /**
1868 * Details about a person whose path was tracked in a video.
1869 */
1870 Person?: PersonDetail;
1871 }
1872 export type PersonDetections = PersonDetection[];
1873 export type PersonIndex = number;
1874 export interface PersonMatch {
1875 /**
1876 * The time, in milliseconds from the beginning of the video, that the person was matched in the video.
1877 */
1878 Timestamp?: Timestamp;
1879 /**
1880 * Information about the matched person.
1881 */
1882 Person?: PersonDetail;
1883 /**
1884 * Information about the faces in the input collection that match the face of a person in the video.
1885 */
1886 FaceMatches?: FaceMatchList;
1887 }
1888 export type PersonMatches = PersonMatch[];
1889 export type PersonTrackingSortBy = "INDEX"|"TIMESTAMP"|string;
1890 export interface Point {
1891 /**
1892 * The value of the X coordinate for a point on a Polygon.
1893 */
1894 X?: Float;
1895 /**
1896 * The value of the Y coordinate for a point on a Polygon.
1897 */
1898 Y?: Float;
1899 }
1900 export type Polygon = Point[];
1901 export interface Pose {
1902 /**
1903 * Value representing the face rotation on the roll axis.
1904 */
1905 Roll?: Degree;
1906 /**
1907 * Value representing the face rotation on the yaw axis.
1908 */
1909 Yaw?: Degree;
1910 /**
1911 * Value representing the face rotation on the pitch axis.
1912 */
1913 Pitch?: Degree;
1914 }
1915 export type ProjectArn = string;
1916 export interface ProjectDescription {
1917 /**
1918 * The Amazon Resource Name (ARN) of the project.
1919 */
1920 ProjectArn?: ProjectArn;
1921 /**
1922 * The Unix timestamp for the date and time that the project was created.
1923 */
1924 CreationTimestamp?: DateTime;
1925 /**
1926 * The current status of the project.
1927 */
1928 Status?: ProjectStatus;
1929 }
1930 export type ProjectDescriptions = ProjectDescription[];
1931 export type ProjectName = string;
1932 export type ProjectStatus = "CREATING"|"CREATED"|"DELETING"|string;
1933 export type ProjectVersionArn = string;
1934 export interface ProjectVersionDescription {
1935 /**
1936 * The Amazon Resource Name (ARN) of the model version.
1937 */
1938 ProjectVersionArn?: ProjectVersionArn;
1939 /**
1940 * The Unix datetime for the date and time that training started.
1941 */
1942 CreationTimestamp?: DateTime;
1943 /**
1944 * The minimum number of inference units used by the model. For more information, see StartProjectVersion.
1945 */
1946 MinInferenceUnits?: InferenceUnits;
1947 /**
1948 * The current status of the model version.
1949 */
1950 Status?: ProjectVersionStatus;
1951 /**
1952 * A descriptive message for an error or warning that occurred.
1953 */
1954 StatusMessage?: StatusMessage;
1955 /**
1956 * 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.
1957 */
1958 BillableTrainingTimeInSeconds?: ULong;
1959 /**
1960 * The Unix date and time that training of the model ended.
1961 */
1962 TrainingEndTimestamp?: DateTime;
1963 /**
1964 * The location where training results are saved.
1965 */
1966 OutputConfig?: OutputConfig;
1967 /**
1968 * The manifest file that represents the training results.
1969 */
1970 TrainingDataResult?: TrainingDataResult;
1971 /**
1972 * The manifest file that represents the testing results.
1973 */
1974 TestingDataResult?: TestingDataResult;
1975 /**
1976 * The training results. EvaluationResult is only returned if training is successful.
1977 */
1978 EvaluationResult?: EvaluationResult;
1979 }
1980 export type ProjectVersionDescriptions = ProjectVersionDescription[];
1981 export type ProjectVersionStatus = "TRAINING_IN_PROGRESS"|"TRAINING_COMPLETED"|"TRAINING_FAILED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|string;
1982 export type ProjectVersionsPageSize = number;
1983 export type ProjectsPageSize = number;
1984 export type QualityFilter = "NONE"|"AUTO"|"LOW"|"MEDIUM"|"HIGH"|string;
1985 export type Reason = "EXCEEDS_MAX_FACES"|"EXTREME_POSE"|"LOW_BRIGHTNESS"|"LOW_SHARPNESS"|"LOW_CONFIDENCE"|"SMALL_BOUNDING_BOX"|"LOW_FACE_QUALITY"|string;
1986 export type Reasons = Reason[];
1987 export interface RecognizeCelebritiesRequest {
1988 /**
1989 * 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.
1990 */
1991 Image: Image;
1992 }
1993 export interface RecognizeCelebritiesResponse {
1994 /**
1995 * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.
1996 */
1997 CelebrityFaces?: CelebrityList;
1998 /**
1999 * Details about each unrecognized face in the image.
2000 */
2001 UnrecognizedFaces?: ComparedFaceList;
2002 /**
2003 * The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected. If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
2004 */
2005 OrientationCorrection?: OrientationCorrection;
2006 }
2007 export interface RegionOfInterest {
2008 /**
2009 * The box representing a region of interest on screen.
2010 */
2011 BoundingBox?: BoundingBox;
2012 }
2013 export type RegionsOfInterest = RegionOfInterest[];
2014 export type RekognitionUniqueId = string;
2015 export type RoleArn = string;
2016 export type S3Bucket = string;
2017 export type S3KeyPrefix = string;
2018 export interface S3Object {
2019 /**
2020 * Name of the S3 bucket.
2021 */
2022 Bucket?: S3Bucket;
2023 /**
2024 * S3 object key name.
2025 */
2026 Name?: S3ObjectName;
2027 /**
2028 * If the bucket is versioning enabled, you can specify the object version.
2029 */
2030 Version?: S3ObjectVersion;
2031 }
2032 export type S3ObjectName = string;
2033 export type S3ObjectVersion = string;
2034 export type SNSTopicArn = string;
2035 export interface SearchFacesByImageRequest {
2036 /**
2037 * ID of the collection to search.
2038 */
2039 CollectionId: CollectionId;
2040 /**
2041 * 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.
2042 */
2043 Image: Image;
2044 /**
2045 * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
2046 */
2047 MaxFaces?: MaxFaces;
2048 /**
2049 * (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
2050 */
2051 FaceMatchThreshold?: Percent;
2052 /**
2053 * 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.
2054 */
2055 QualityFilter?: QualityFilter;
2056 }
2057 export interface SearchFacesByImageResponse {
2058 /**
2059 * The bounding box around the face in the input image that Amazon Rekognition used for the search.
2060 */
2061 SearchedFaceBoundingBox?: BoundingBox;
2062 /**
2063 * The level of confidence that the searchedFaceBoundingBox, contains a face.
2064 */
2065 SearchedFaceConfidence?: Percent;
2066 /**
2067 * An array of faces that match the input face, along with the confidence in the match.
2068 */
2069 FaceMatches?: FaceMatchList;
2070 /**
2071 * Version number of the face detection model associated with the input collection (CollectionId).
2072 */
2073 FaceModelVersion?: String;
2074 }
2075 export interface SearchFacesRequest {
2076 /**
2077 * ID of the collection the face belongs to.
2078 */
2079 CollectionId: CollectionId;
2080 /**
2081 * ID of a face to find matches for in the collection.
2082 */
2083 FaceId: FaceId;
2084 /**
2085 * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
2086 */
2087 MaxFaces?: MaxFaces;
2088 /**
2089 * Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
2090 */
2091 FaceMatchThreshold?: Percent;
2092 }
2093 export interface SearchFacesResponse {
2094 /**
2095 * ID of the face that was searched for matches in a collection.
2096 */
2097 SearchedFaceId?: FaceId;
2098 /**
2099 * An array of faces that matched the input face, along with the confidence in the match.
2100 */
2101 FaceMatches?: FaceMatchList;
2102 /**
2103 * Version number of the face detection model associated with the input collection (CollectionId).
2104 */
2105 FaceModelVersion?: String;
2106 }
2107 export interface Smile {
2108 /**
2109 * Boolean value that indicates whether the face is smiling or not.
2110 */
2111 Value?: Boolean;
2112 /**
2113 * Level of confidence in the determination.
2114 */
2115 Confidence?: Percent;
2116 }
2117 export interface StartCelebrityRecognitionRequest {
2118 /**
2119 * The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
2120 */
2121 Video: Video;
2122 /**
2123 * Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2124 */
2125 ClientRequestToken?: ClientRequestToken;
2126 /**
2127 * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
2128 */
2129 NotificationChannel?: NotificationChannel;
2130 /**
2131 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2132 */
2133 JobTag?: JobTag;
2134 }
2135 export interface StartCelebrityRecognitionResponse {
2136 /**
2137 * The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.
2138 */
2139 JobId?: JobId;
2140 }
2141 export interface StartContentModerationRequest {
2142 /**
2143 * The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.
2144 */
2145 Video: Video;
2146 /**
2147 * Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify MinConfidence, GetContentModeration returns labels with confidence values greater than or equal to 50 percent.
2148 */
2149 MinConfidence?: Percent;
2150 /**
2151 * Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2152 */
2153 ClientRequestToken?: ClientRequestToken;
2154 /**
2155 * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the unsafe content analysis to.
2156 */
2157 NotificationChannel?: NotificationChannel;
2158 /**
2159 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2160 */
2161 JobTag?: JobTag;
2162 }
2163 export interface StartContentModerationResponse {
2164 /**
2165 * The identifier for the unsafe content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.
2166 */
2167 JobId?: JobId;
2168 }
2169 export interface StartFaceDetectionRequest {
2170 /**
2171 * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
2172 */
2173 Video: Video;
2174 /**
2175 * Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2176 */
2177 ClientRequestToken?: ClientRequestToken;
2178 /**
2179 * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
2180 */
2181 NotificationChannel?: NotificationChannel;
2182 /**
2183 * The face attributes you want returned. DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. ALL - All facial attributes are returned.
2184 */
2185 FaceAttributes?: FaceAttributes;
2186 /**
2187 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2188 */
2189 JobTag?: JobTag;
2190 }
2191 export interface StartFaceDetectionResponse {
2192 /**
2193 * The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.
2194 */
2195 JobId?: JobId;
2196 }
2197 export interface StartFaceSearchRequest {
2198 /**
2199 * The video you want to search. The video must be stored in an Amazon S3 bucket.
2200 */
2201 Video: Video;
2202 /**
2203 * Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2204 */
2205 ClientRequestToken?: ClientRequestToken;
2206 /**
2207 * The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
2208 */
2209 FaceMatchThreshold?: Percent;
2210 /**
2211 * ID of the collection that contains the faces you want to search for.
2212 */
2213 CollectionId: CollectionId;
2214 /**
2215 * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
2216 */
2217 NotificationChannel?: NotificationChannel;
2218 /**
2219 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2220 */
2221 JobTag?: JobTag;
2222 }
2223 export interface StartFaceSearchResponse {
2224 /**
2225 * The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.
2226 */
2227 JobId?: JobId;
2228 }
2229 export interface StartLabelDetectionRequest {
2230 /**
2231 * The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
2232 */
2233 Video: Video;
2234 /**
2235 * Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2236 */
2237 ClientRequestToken?: ClientRequestToken;
2238 /**
2239 * Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video 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.
2240 */
2241 MinConfidence?: Percent;
2242 /**
2243 * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
2244 */
2245 NotificationChannel?: NotificationChannel;
2246 /**
2247 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2248 */
2249 JobTag?: JobTag;
2250 }
2251 export interface StartLabelDetectionResponse {
2252 /**
2253 * The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.
2254 */
2255 JobId?: JobId;
2256 }
2257 export interface StartPersonTrackingRequest {
2258 /**
2259 * The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
2260 */
2261 Video: Video;
2262 /**
2263 * Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
2264 */
2265 ClientRequestToken?: ClientRequestToken;
2266 /**
2267 * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
2268 */
2269 NotificationChannel?: NotificationChannel;
2270 /**
2271 * An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2272 */
2273 JobTag?: JobTag;
2274 }
2275 export interface StartPersonTrackingResponse {
2276 /**
2277 * The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.
2278 */
2279 JobId?: JobId;
2280 }
2281 export interface StartProjectVersionRequest {
2282 /**
2283 * The Amazon Resource Name(ARN) of the model version that you want to start.
2284 */
2285 ProjectVersionArn: ProjectVersionArn;
2286 /**
2287 * 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.
2288 */
2289 MinInferenceUnits: InferenceUnits;
2290 }
2291 export interface StartProjectVersionResponse {
2292 /**
2293 * The current running status of the model.
2294 */
2295 Status?: ProjectVersionStatus;
2296 }
2297 export interface StartStreamProcessorRequest {
2298 /**
2299 * The name of the stream processor to start processing.
2300 */
2301 Name: StreamProcessorName;
2302 }
2303 export interface StartStreamProcessorResponse {
2304 }
2305 export interface StartTextDetectionFilters {
2306 /**
2307 * Filters focusing on qualities of the text, such as confidence or size.
2308 */
2309 WordFilter?: DetectionFilter;
2310 /**
2311 * Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.
2312 */
2313 RegionsOfInterest?: RegionsOfInterest;
2314 }
2315 export interface StartTextDetectionRequest {
2316 Video: Video;
2317 /**
2318 * Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
2319 */
2320 ClientRequestToken?: ClientRequestToken;
2321 NotificationChannel?: NotificationChannel;
2322 /**
2323 * An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
2324 */
2325 JobTag?: JobTag;
2326 /**
2327 * Optional parameters that let you set criteria the text must meet to be included in your response.
2328 */
2329 Filters?: StartTextDetectionFilters;
2330 }
2331 export interface StartTextDetectionResponse {
2332 /**
2333 * Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.
2334 */
2335 JobId?: JobId;
2336 }
2337 export type StatusMessage = string;
2338 export interface StopProjectVersionRequest {
2339 /**
2340 * The Amazon Resource Name (ARN) of the model version that you want to delete. This operation requires permissions to perform the rekognition:StopProjectVersion action.
2341 */
2342 ProjectVersionArn: ProjectVersionArn;
2343 }
2344 export interface StopProjectVersionResponse {
2345 /**
2346 * The current status of the stop operation.
2347 */
2348 Status?: ProjectVersionStatus;
2349 }
2350 export interface StopStreamProcessorRequest {
2351 /**
2352 * The name of a stream processor created by CreateStreamProcessor.
2353 */
2354 Name: StreamProcessorName;
2355 }
2356 export interface StopStreamProcessorResponse {
2357 }
2358 export interface StreamProcessor {
2359 /**
2360 * Name of the Amazon Rekognition stream processor.
2361 */
2362 Name?: StreamProcessorName;
2363 /**
2364 * Current status of the Amazon Rekognition stream processor.
2365 */
2366 Status?: StreamProcessorStatus;
2367 }
2368 export type StreamProcessorArn = string;
2369 export interface StreamProcessorInput {
2370 /**
2371 * The Kinesis video stream input stream for the source streaming video.
2372 */
2373 KinesisVideoStream?: KinesisVideoStream;
2374 }
2375 export type StreamProcessorList = StreamProcessor[];
2376 export type StreamProcessorName = string;
2377 export interface StreamProcessorOutput {
2378 /**
2379 * The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
2380 */
2381 KinesisDataStream?: KinesisDataStream;
2382 }
2383 export interface StreamProcessorSettings {
2384 /**
2385 * Face search settings to use on a streaming video.
2386 */
2387 FaceSearch?: FaceSearchSettings;
2388 }
2389 export type StreamProcessorStatus = "STOPPED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|string;
2390 export type String = string;
2391 export interface Summary {
2392 S3Object?: S3Object;
2393 }
2394 export interface Sunglasses {
2395 /**
2396 * Boolean value that indicates whether the face is wearing sunglasses or not.
2397 */
2398 Value?: Boolean;
2399 /**
2400 * Level of confidence in the determination.
2401 */
2402 Confidence?: Percent;
2403 }
2404 export interface TestingData {
2405 /**
2406 * The assets used for testing.
2407 */
2408 Assets?: Assets;
2409 /**
2410 * If specified, Amazon Rekognition Custom Labels creates a testing dataset with an 80/20 split of the training dataset.
2411 */
2412 AutoCreate?: Boolean;
2413 }
2414 export interface TestingDataResult {
2415 /**
2416 * The testing dataset that was supplied for training.
2417 */
2418 Input?: TestingData;
2419 /**
2420 * The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.
2421 */
2422 Output?: TestingData;
2423 }
2424 export interface TextDetection {
2425 /**
2426 * The word or line of text recognized by Amazon Rekognition.
2427 */
2428 DetectedText?: String;
2429 /**
2430 * The type of text that was detected.
2431 */
2432 Type?: TextTypes;
2433 /**
2434 * The identifier for the detected text. The identifier is only unique for a single call to DetectText.
2435 */
2436 Id?: UInteger;
2437 /**
2438 * The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.
2439 */
2440 ParentId?: UInteger;
2441 /**
2442 * The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
2443 */
2444 Confidence?: Percent;
2445 /**
2446 * The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.
2447 */
2448 Geometry?: Geometry;
2449 }
2450 export type TextDetectionList = TextDetection[];
2451 export interface TextDetectionResult {
2452 /**
2453 * The time, in milliseconds from the start of the video, that the text was detected.
2454 */
2455 Timestamp?: Timestamp;
2456 /**
2457 * Details about text detected in a video.
2458 */
2459 TextDetection?: TextDetection;
2460 }
2461 export type TextDetectionResults = TextDetectionResult[];
2462 export type TextTypes = "LINE"|"WORD"|string;
2463 export type Timestamp = number;
2464 export interface TrainingData {
2465 /**
2466 * A Sagemaker GroundTruth manifest file that contains the training images (assets).
2467 */
2468 Assets?: Assets;
2469 }
2470 export interface TrainingDataResult {
2471 /**
2472 * The training assets that you supplied for training.
2473 */
2474 Input?: TrainingData;
2475 /**
2476 * The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
2477 */
2478 Output?: TrainingData;
2479 }
2480 export type UInteger = number;
2481 export type ULong = number;
2482 export interface UnindexedFace {
2483 /**
2484 * An array of reasons that specify why a face wasn't indexed. EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera. EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces. LOW_BRIGHTNESS - The image is too dark. LOW_SHARPNESS - The image is too blurry. LOW_CONFIDENCE - The face was detected with a low confidence. SMALL_BOUNDING_BOX - The bounding box around the face is too small.
2485 */
2486 Reasons?: Reasons;
2487 /**
2488 * The structure that contains attributes of a face that IndexFacesdetected, but didn't index.
2489 */
2490 FaceDetail?: FaceDetail;
2491 }
2492 export type UnindexedFaces = UnindexedFace[];
2493 export type Url = string;
2494 export type Urls = Url[];
2495 export type VersionName = string;
2496 export type VersionNames = VersionName[];
2497 export interface Video {
2498 /**
2499 * The Amazon S3 bucket name and file name for the video.
2500 */
2501 S3Object?: S3Object;
2502 }
2503 export type VideoJobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
2504 export interface VideoMetadata {
2505 /**
2506 * Type of compression used in the analyzed video.
2507 */
2508 Codec?: String;
2509 /**
2510 * Length of the video in milliseconds.
2511 */
2512 DurationMillis?: ULong;
2513 /**
2514 * Format of the analyzed video. Possible values are MP4, MOV and AVI.
2515 */
2516 Format?: String;
2517 /**
2518 * Number of frames per second in the video.
2519 */
2520 FrameRate?: Float;
2521 /**
2522 * Vertical pixel dimension of the video.
2523 */
2524 FrameHeight?: ULong;
2525 /**
2526 * Horizontal pixel dimension of the video.
2527 */
2528 FrameWidth?: ULong;
2529 }
2530 /**
2531 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2532 */
2533 export type apiVersion = "2016-06-27"|"latest"|string;
2534 export interface ClientApiVersions {
2535 /**
2536 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2537 */
2538 apiVersion?: apiVersion;
2539 }
2540 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2541 /**
2542 * Contains interfaces for use with the Rekognition client.
2543 */
2544 export import Types = Rekognition;
2545}
2546export = Rekognition;