UNPKG

162 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class Rekognition extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: Rekognition.Types.ClientConfiguration)
13 config: Config & Rekognition.Types.ClientConfiguration;
14 /**
15 * Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
16 */
17 compareFaces(params: Rekognition.Types.CompareFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
18 /**
19 * Compares a face in the source input image with each of the 100 largest faces detected in the target input image. If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter. CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error. This is a stateless API operation. That is, data returned by this operation doesn't persist. For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:CompareFaces action.
20 */
21 compareFaces(callback?: (err: AWSError, data: Rekognition.Types.CompareFacesResponse) => void): Request<Rekognition.Types.CompareFacesResponse, AWSError>;
22 /**
23 * 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.
24 */
25 createCollection(params: Rekognition.Types.CreateCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request<Rekognition.Types.CreateCollectionResponse, AWSError>;
26 /**
27 * Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation. For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. When you create a collection, it is associated with the latest version of the face model version. Collection names are case-sensitive. This operation requires permissions to perform the rekognition:CreateCollection action.
28 */
29 createCollection(callback?: (err: AWSError, data: Rekognition.Types.CreateCollectionResponse) => void): Request<Rekognition.Types.CreateCollectionResponse, AWSError>;
30 /**
31 * Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams. You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.
32 */
33 createStreamProcessor(params: Rekognition.Types.CreateStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request<Rekognition.Types.CreateStreamProcessorResponse, AWSError>;
34 /**
35 * 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.
36 */
37 createStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.CreateStreamProcessorResponse) => void): Request<Rekognition.Types.CreateStreamProcessorResponse, AWSError>;
38 /**
39 * 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.
40 */
41 deleteCollection(params: Rekognition.Types.DeleteCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request<Rekognition.Types.DeleteCollectionResponse, AWSError>;
42 /**
43 * 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.
44 */
45 deleteCollection(callback?: (err: AWSError, data: Rekognition.Types.DeleteCollectionResponse) => void): Request<Rekognition.Types.DeleteCollectionResponse, AWSError>;
46 /**
47 * 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.
48 */
49 deleteFaces(params: Rekognition.Types.DeleteFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request<Rekognition.Types.DeleteFacesResponse, AWSError>;
50 /**
51 * 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.
52 */
53 deleteFaces(callback?: (err: AWSError, data: Rekognition.Types.DeleteFacesResponse) => void): Request<Rekognition.Types.DeleteFacesResponse, AWSError>;
54 /**
55 * 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.
56 */
57 deleteStreamProcessor(params: Rekognition.Types.DeleteStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request<Rekognition.Types.DeleteStreamProcessorResponse, AWSError>;
58 /**
59 * 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.
60 */
61 deleteStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DeleteStreamProcessorResponse) => void): Request<Rekognition.Types.DeleteStreamProcessorResponse, AWSError>;
62 /**
63 * 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.
64 */
65 describeCollection(params: Rekognition.Types.DescribeCollectionRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request<Rekognition.Types.DescribeCollectionResponse, AWSError>;
66 /**
67 * Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.
68 */
69 describeCollection(callback?: (err: AWSError, data: Rekognition.Types.DescribeCollectionResponse) => void): Request<Rekognition.Types.DescribeCollectionResponse, AWSError>;
70 /**
71 * Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
72 */
73 describeStreamProcessor(params: Rekognition.Types.DescribeStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request<Rekognition.Types.DescribeStreamProcessorResponse, AWSError>;
74 /**
75 * Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
76 */
77 describeStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.DescribeStreamProcessorResponse) => void): Request<Rekognition.Types.DescribeStreamProcessorResponse, AWSError>;
78 /**
79 * 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), gender, presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action.
80 */
81 detectFaces(params: Rekognition.Types.DetectFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request<Rekognition.Types.DetectFacesResponse, AWSError>;
82 /**
83 * 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), gender, presence of beard, sunglasses, and so on. The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. This is a stateless API operation. That is, the operation does not persist any data. This operation requires permissions to perform the rekognition:DetectFaces action.
84 */
85 detectFaces(callback?: (err: AWSError, data: Rekognition.Types.DetectFacesResponse) => void): Request<Rekognition.Types.DetectFacesResponse, AWSError>;
86 /**
87 * 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.
88 */
89 detectLabels(params: Rekognition.Types.DetectLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request<Rekognition.Types.DetectLabelsResponse, AWSError>;
90 /**
91 * 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.
92 */
93 detectLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectLabelsResponse) => void): Request<Rekognition.Types.DetectLabelsResponse, AWSError>;
94 /**
95 * 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.
96 */
97 detectModerationLabels(params: Rekognition.Types.DetectModerationLabelsRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request<Rekognition.Types.DetectModerationLabelsResponse, AWSError>;
98 /**
99 * 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.
100 */
101 detectModerationLabels(callback?: (err: AWSError, data: Rekognition.Types.DetectModerationLabelsResponse) => void): Request<Rekognition.Types.DetectModerationLabelsResponse, AWSError>;
102 /**
103 * 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.
104 */
105 detectText(params: Rekognition.Types.DetectTextRequest, callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request<Rekognition.Types.DetectTextResponse, AWSError>;
106 /**
107 * 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.
108 */
109 detectText(callback?: (err: AWSError, data: Rekognition.Types.DetectTextResponse) => void): Request<Rekognition.Types.DetectTextResponse, AWSError>;
110 /**
111 * 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.
112 */
113 getCelebrityInfo(params: Rekognition.Types.GetCelebrityInfoRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request<Rekognition.Types.GetCelebrityInfoResponse, AWSError>;
114 /**
115 * 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.
116 */
117 getCelebrityInfo(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityInfoResponse) => void): Request<Rekognition.Types.GetCelebrityInfoResponse, AWSError>;
118 /**
119 * 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.
120 */
121 getCelebrityRecognition(params: Rekognition.Types.GetCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request<Rekognition.Types.GetCelebrityRecognitionResponse, AWSError>;
122 /**
123 * 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.
124 */
125 getCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.GetCelebrityRecognitionResponse) => void): Request<Rekognition.Types.GetCelebrityRecognitionResponse, AWSError>;
126 /**
127 * 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.
128 */
129 getContentModeration(params: Rekognition.Types.GetContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request<Rekognition.Types.GetContentModerationResponse, AWSError>;
130 /**
131 * 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.
132 */
133 getContentModeration(callback?: (err: AWSError, data: Rekognition.Types.GetContentModerationResponse) => void): Request<Rekognition.Types.GetContentModerationResponse, AWSError>;
134 /**
135 * 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.
136 */
137 getFaceDetection(params: Rekognition.Types.GetFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request<Rekognition.Types.GetFaceDetectionResponse, AWSError>;
138 /**
139 * 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.
140 */
141 getFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.GetFaceDetectionResponse) => void): Request<Rekognition.Types.GetFaceDetectionResponse, AWSError>;
142 /**
143 * 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.
144 */
145 getFaceSearch(params: Rekognition.Types.GetFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request<Rekognition.Types.GetFaceSearchResponse, AWSError>;
146 /**
147 * 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.
148 */
149 getFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.GetFaceSearchResponse) => void): Request<Rekognition.Types.GetFaceSearchResponse, AWSError>;
150 /**
151 * 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.
152 */
153 getLabelDetection(params: Rekognition.Types.GetLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request<Rekognition.Types.GetLabelDetectionResponse, AWSError>;
154 /**
155 * 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.
156 */
157 getLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.GetLabelDetectionResponse) => void): Request<Rekognition.Types.GetLabelDetectionResponse, AWSError>;
158 /**
159 * 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.
160 */
161 getPersonTracking(params: Rekognition.Types.GetPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request<Rekognition.Types.GetPersonTrackingResponse, AWSError>;
162 /**
163 * 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.
164 */
165 getPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.GetPersonTrackingResponse) => void): Request<Rekognition.Types.GetPersonTrackingResponse, AWSError>;
166 /**
167 * 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 the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. 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. 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. 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 like gender. 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.
168 */
169 indexFaces(params: Rekognition.Types.IndexFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request<Rekognition.Types.IndexFacesResponse, AWSError>;
170 /**
171 * 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 the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. 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. 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. 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 like gender. 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.
172 */
173 indexFaces(callback?: (err: AWSError, data: Rekognition.Types.IndexFacesResponse) => void): Request<Rekognition.Types.IndexFacesResponse, AWSError>;
174 /**
175 * 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.
176 */
177 listCollections(params: Rekognition.Types.ListCollectionsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request<Rekognition.Types.ListCollectionsResponse, AWSError>;
178 /**
179 * 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.
180 */
181 listCollections(callback?: (err: AWSError, data: Rekognition.Types.ListCollectionsResponse) => void): Request<Rekognition.Types.ListCollectionsResponse, AWSError>;
182 /**
183 * 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.
184 */
185 listFaces(params: Rekognition.Types.ListFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request<Rekognition.Types.ListFacesResponse, AWSError>;
186 /**
187 * 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.
188 */
189 listFaces(callback?: (err: AWSError, data: Rekognition.Types.ListFacesResponse) => void): Request<Rekognition.Types.ListFacesResponse, AWSError>;
190 /**
191 * Gets a list of stream processors that you have created with CreateStreamProcessor.
192 */
193 listStreamProcessors(params: Rekognition.Types.ListStreamProcessorsRequest, callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
194 /**
195 * Gets a list of stream processors that you have created with CreateStreamProcessor.
196 */
197 listStreamProcessors(callback?: (err: AWSError, data: Rekognition.Types.ListStreamProcessorsResponse) => void): Request<Rekognition.Types.ListStreamProcessorsResponse, AWSError>;
198 /**
199 * 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.
200 */
201 recognizeCelebrities(params: Rekognition.Types.RecognizeCelebritiesRequest, callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
202 /**
203 * 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.
204 */
205 recognizeCelebrities(callback?: (err: AWSError, data: Rekognition.Types.RecognizeCelebritiesResponse) => void): Request<Rekognition.Types.RecognizeCelebritiesResponse, AWSError>;
206 /**
207 * 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.
208 */
209 searchFaces(params: Rekognition.Types.SearchFacesRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request<Rekognition.Types.SearchFacesResponse, AWSError>;
210 /**
211 * 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.
212 */
213 searchFaces(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesResponse) => void): Request<Rekognition.Types.SearchFacesResponse, AWSError>;
214 /**
215 * For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFacesByImage action.
216 */
217 searchFacesByImage(params: Rekognition.Types.SearchFacesByImageRequest, callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
218 /**
219 * For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation. You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation. You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. This operation requires permissions to perform the rekognition:SearchFacesByImage action.
220 */
221 searchFacesByImage(callback?: (err: AWSError, data: Rekognition.Types.SearchFacesByImageResponse) => void): Request<Rekognition.Types.SearchFacesByImageResponse, AWSError>;
222 /**
223 * 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.
224 */
225 startCelebrityRecognition(params: Rekognition.Types.StartCelebrityRecognitionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request<Rekognition.Types.StartCelebrityRecognitionResponse, AWSError>;
226 /**
227 * 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.
228 */
229 startCelebrityRecognition(callback?: (err: AWSError, data: Rekognition.Types.StartCelebrityRecognitionResponse) => void): Request<Rekognition.Types.StartCelebrityRecognitionResponse, AWSError>;
230 /**
231 * 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.
232 */
233 startContentModeration(params: Rekognition.Types.StartContentModerationRequest, callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request<Rekognition.Types.StartContentModerationResponse, AWSError>;
234 /**
235 * 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.
236 */
237 startContentModeration(callback?: (err: AWSError, data: Rekognition.Types.StartContentModerationResponse) => void): Request<Rekognition.Types.StartContentModerationResponse, AWSError>;
238 /**
239 * 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.
240 */
241 startFaceDetection(params: Rekognition.Types.StartFaceDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request<Rekognition.Types.StartFaceDetectionResponse, AWSError>;
242 /**
243 * 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.
244 */
245 startFaceDetection(callback?: (err: AWSError, data: Rekognition.Types.StartFaceDetectionResponse) => void): Request<Rekognition.Types.StartFaceDetectionResponse, AWSError>;
246 /**
247 * 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.
248 */
249 startFaceSearch(params: Rekognition.Types.StartFaceSearchRequest, callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request<Rekognition.Types.StartFaceSearchResponse, AWSError>;
250 /**
251 * 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.
252 */
253 startFaceSearch(callback?: (err: AWSError, data: Rekognition.Types.StartFaceSearchResponse) => void): Request<Rekognition.Types.StartFaceSearchResponse, AWSError>;
254 /**
255 * 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.
256 */
257 startLabelDetection(params: Rekognition.Types.StartLabelDetectionRequest, callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request<Rekognition.Types.StartLabelDetectionResponse, AWSError>;
258 /**
259 * 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.
260 */
261 startLabelDetection(callback?: (err: AWSError, data: Rekognition.Types.StartLabelDetectionResponse) => void): Request<Rekognition.Types.StartLabelDetectionResponse, AWSError>;
262 /**
263 * 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.
264 */
265 startPersonTracking(params: Rekognition.Types.StartPersonTrackingRequest, callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request<Rekognition.Types.StartPersonTrackingResponse, AWSError>;
266 /**
267 * Starts the asynchronous tracking of a person's path in a stored video. Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.
268 */
269 startPersonTracking(callback?: (err: AWSError, data: Rekognition.Types.StartPersonTrackingResponse) => void): Request<Rekognition.Types.StartPersonTrackingResponse, AWSError>;
270 /**
271 * Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.
272 */
273 startStreamProcessor(params: Rekognition.Types.StartStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request<Rekognition.Types.StartStreamProcessorResponse, AWSError>;
274 /**
275 * Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.
276 */
277 startStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StartStreamProcessorResponse) => void): Request<Rekognition.Types.StartStreamProcessorResponse, AWSError>;
278 /**
279 * Stops a running stream processor that was created by CreateStreamProcessor.
280 */
281 stopStreamProcessor(params: Rekognition.Types.StopStreamProcessorRequest, callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
282 /**
283 * Stops a running stream processor that was created by CreateStreamProcessor.
284 */
285 stopStreamProcessor(callback?: (err: AWSError, data: Rekognition.Types.StopStreamProcessorResponse) => void): Request<Rekognition.Types.StopStreamProcessorResponse, AWSError>;
286}
287declare namespace Rekognition {
288 export interface AgeRange {
289 /**
290 * The lowest estimated age.
291 */
292 Low?: UInteger;
293 /**
294 * The highest estimated age.
295 */
296 High?: UInteger;
297 }
298 export type Attribute = "DEFAULT"|"ALL"|string;
299 export type Attributes = Attribute[];
300 export interface Beard {
301 /**
302 * Boolean value that indicates whether the face has beard or not.
303 */
304 Value?: Boolean;
305 /**
306 * Level of confidence in the determination.
307 */
308 Confidence?: Percent;
309 }
310 export type Boolean = boolean;
311 export interface BoundingBox {
312 /**
313 * Width of the bounding box as a ratio of the overall image width.
314 */
315 Width?: Float;
316 /**
317 * Height of the bounding box as a ratio of the overall image height.
318 */
319 Height?: Float;
320 /**
321 * Left coordinate of the bounding box as a ratio of overall image width.
322 */
323 Left?: Float;
324 /**
325 * Top coordinate of the bounding box as a ratio of overall image height.
326 */
327 Top?: Float;
328 }
329 export interface Celebrity {
330 /**
331 * An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
332 */
333 Urls?: Urls;
334 /**
335 * The name of the celebrity.
336 */
337 Name?: String;
338 /**
339 * A unique identifier for the celebrity.
340 */
341 Id?: RekognitionUniqueId;
342 /**
343 * Provides information about the celebrity's face, such as its location on the image.
344 */
345 Face?: ComparedFace;
346 /**
347 * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
348 */
349 MatchConfidence?: Percent;
350 }
351 export interface CelebrityDetail {
352 /**
353 * An array of URLs pointing to additional celebrity information.
354 */
355 Urls?: Urls;
356 /**
357 * The name of the celebrity.
358 */
359 Name?: String;
360 /**
361 * The unique identifier for the celebrity.
362 */
363 Id?: RekognitionUniqueId;
364 /**
365 * The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
366 */
367 Confidence?: Percent;
368 /**
369 * Bounding box around the body of a celebrity.
370 */
371 BoundingBox?: BoundingBox;
372 /**
373 * Face details for the recognized celebrity.
374 */
375 Face?: FaceDetail;
376 }
377 export type CelebrityList = Celebrity[];
378 export interface CelebrityRecognition {
379 /**
380 * The time, in milliseconds from the start of the video, that the celebrity was recognized.
381 */
382 Timestamp?: Timestamp;
383 /**
384 * Information about a recognized celebrity.
385 */
386 Celebrity?: CelebrityDetail;
387 }
388 export type CelebrityRecognitionSortBy = "ID"|"TIMESTAMP"|string;
389 export type CelebrityRecognitions = CelebrityRecognition[];
390 export type ClientRequestToken = string;
391 export type CollectionId = string;
392 export type CollectionIdList = CollectionId[];
393 export interface CompareFacesMatch {
394 /**
395 * Level of confidence that the faces match.
396 */
397 Similarity?: Percent;
398 /**
399 * Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
400 */
401 Face?: ComparedFace;
402 }
403 export type CompareFacesMatchList = CompareFacesMatch[];
404 export interface CompareFacesRequest {
405 /**
406 * 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.
407 */
408 SourceImage: Image;
409 /**
410 * 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.
411 */
412 TargetImage: Image;
413 /**
414 * The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
415 */
416 SimilarityThreshold?: Percent;
417 }
418 export interface CompareFacesResponse {
419 /**
420 * The face in the source image that was used for comparison.
421 */
422 SourceImageFace?: ComparedSourceImageFace;
423 /**
424 * 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.
425 */
426 FaceMatches?: CompareFacesMatchList;
427 /**
428 * An array of faces in the target image that did not match the source image face.
429 */
430 UnmatchedFaces?: CompareFacesUnmatchList;
431 /**
432 * 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.
433 */
434 SourceImageOrientationCorrection?: OrientationCorrection;
435 /**
436 * 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.
437 */
438 TargetImageOrientationCorrection?: OrientationCorrection;
439 }
440 export type CompareFacesUnmatchList = ComparedFace[];
441 export interface ComparedFace {
442 /**
443 * Bounding box of the face.
444 */
445 BoundingBox?: BoundingBox;
446 /**
447 * Level of confidence that what the bounding box contains is a face.
448 */
449 Confidence?: Percent;
450 /**
451 * An array of facial landmarks.
452 */
453 Landmarks?: Landmarks;
454 /**
455 * Indicates the pose of the face as determined by its pitch, roll, and yaw.
456 */
457 Pose?: Pose;
458 /**
459 * Identifies face image brightness and sharpness.
460 */
461 Quality?: ImageQuality;
462 }
463 export type ComparedFaceList = ComparedFace[];
464 export interface ComparedSourceImageFace {
465 /**
466 * Bounding box of the face.
467 */
468 BoundingBox?: BoundingBox;
469 /**
470 * Confidence level that the selected bounding box contains a face.
471 */
472 Confidence?: Percent;
473 }
474 export interface ContentModerationDetection {
475 /**
476 * Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.
477 */
478 Timestamp?: Timestamp;
479 /**
480 * The unsafe content label detected by in the stored video.
481 */
482 ModerationLabel?: ModerationLabel;
483 }
484 export type ContentModerationDetections = ContentModerationDetection[];
485 export type ContentModerationSortBy = "NAME"|"TIMESTAMP"|string;
486 export interface CreateCollectionRequest {
487 /**
488 * ID for the collection that you are creating.
489 */
490 CollectionId: CollectionId;
491 }
492 export interface CreateCollectionResponse {
493 /**
494 * HTTP status code indicating the result of the operation.
495 */
496 StatusCode?: UInteger;
497 /**
498 * Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
499 */
500 CollectionArn?: String;
501 /**
502 * Version number of the face detection model associated with the collection you are creating.
503 */
504 FaceModelVersion?: String;
505 }
506 export interface CreateStreamProcessorRequest {
507 /**
508 * Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.
509 */
510 Input: StreamProcessorInput;
511 /**
512 * 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.
513 */
514 Output: StreamProcessorOutput;
515 /**
516 * 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.
517 */
518 Name: StreamProcessorName;
519 /**
520 * 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.
521 */
522 Settings: StreamProcessorSettings;
523 /**
524 * ARN of the IAM role that allows access to the stream processor.
525 */
526 RoleArn: RoleArn;
527 }
528 export interface CreateStreamProcessorResponse {
529 /**
530 * ARN for the newly create stream processor.
531 */
532 StreamProcessorArn?: StreamProcessorArn;
533 }
534 export type DateTime = Date;
535 export type Degree = number;
536 export interface DeleteCollectionRequest {
537 /**
538 * ID of the collection to delete.
539 */
540 CollectionId: CollectionId;
541 }
542 export interface DeleteCollectionResponse {
543 /**
544 * HTTP status code that indicates the result of the operation.
545 */
546 StatusCode?: UInteger;
547 }
548 export interface DeleteFacesRequest {
549 /**
550 * Collection from which to remove the specific faces.
551 */
552 CollectionId: CollectionId;
553 /**
554 * An array of face IDs to delete.
555 */
556 FaceIds: FaceIdList;
557 }
558 export interface DeleteFacesResponse {
559 /**
560 * An array of strings (face IDs) of the faces that were deleted.
561 */
562 DeletedFaces?: FaceIdList;
563 }
564 export interface DeleteStreamProcessorRequest {
565 /**
566 * The name of the stream processor you want to delete.
567 */
568 Name: StreamProcessorName;
569 }
570 export interface DeleteStreamProcessorResponse {
571 }
572 export interface DescribeCollectionRequest {
573 /**
574 * The ID of the collection to describe.
575 */
576 CollectionId: CollectionId;
577 }
578 export interface DescribeCollectionResponse {
579 /**
580 * The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
581 */
582 FaceCount?: ULong;
583 /**
584 * 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.
585 */
586 FaceModelVersion?: String;
587 /**
588 * The Amazon Resource Name (ARN) of the collection.
589 */
590 CollectionARN?: String;
591 /**
592 * 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.
593 */
594 CreationTimestamp?: DateTime;
595 }
596 export interface DescribeStreamProcessorRequest {
597 /**
598 * Name of the stream processor for which you want information.
599 */
600 Name: StreamProcessorName;
601 }
602 export interface DescribeStreamProcessorResponse {
603 /**
604 * Name of the stream processor.
605 */
606 Name?: StreamProcessorName;
607 /**
608 * ARN of the stream processor.
609 */
610 StreamProcessorArn?: StreamProcessorArn;
611 /**
612 * Current status of the stream processor.
613 */
614 Status?: StreamProcessorStatus;
615 /**
616 * Detailed status message about the stream processor.
617 */
618 StatusMessage?: String;
619 /**
620 * Date and time the stream processor was created
621 */
622 CreationTimestamp?: DateTime;
623 /**
624 * 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.
625 */
626 LastUpdateTimestamp?: DateTime;
627 /**
628 * Kinesis video stream that provides the source streaming video.
629 */
630 Input?: StreamProcessorInput;
631 /**
632 * Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
633 */
634 Output?: StreamProcessorOutput;
635 /**
636 * ARN of the IAM role that allows access to the stream processor.
637 */
638 RoleArn?: RoleArn;
639 /**
640 * 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.
641 */
642 Settings?: StreamProcessorSettings;
643 }
644 export interface DetectFacesRequest {
645 /**
646 * 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.
647 */
648 Image: Image;
649 /**
650 * 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).
651 */
652 Attributes?: Attributes;
653 }
654 export interface DetectFacesResponse {
655 /**
656 * Details of each face found in the image.
657 */
658 FaceDetails?: FaceDetailList;
659 /**
660 * 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.
661 */
662 OrientationCorrection?: OrientationCorrection;
663 }
664 export interface DetectLabelsRequest {
665 /**
666 * 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.
667 */
668 Image: Image;
669 /**
670 * Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
671 */
672 MaxLabels?: UInteger;
673 /**
674 * 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.
675 */
676 MinConfidence?: Percent;
677 }
678 export interface DetectLabelsResponse {
679 /**
680 * An array of labels for the real-world objects detected.
681 */
682 Labels?: Labels;
683 /**
684 * 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.
685 */
686 OrientationCorrection?: OrientationCorrection;
687 /**
688 * Version number of the label detection model that was used to detect labels.
689 */
690 LabelModelVersion?: String;
691 }
692 export interface DetectModerationLabelsRequest {
693 /**
694 * 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.
695 */
696 Image: Image;
697 /**
698 * 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.
699 */
700 MinConfidence?: Percent;
701 }
702 export interface DetectModerationLabelsResponse {
703 /**
704 * Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.
705 */
706 ModerationLabels?: ModerationLabels;
707 /**
708 * Version number of the moderation detection model that was used to detect unsafe content.
709 */
710 ModerationModelVersion?: String;
711 }
712 export interface DetectTextRequest {
713 /**
714 * 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.
715 */
716 Image: Image;
717 }
718 export interface DetectTextResponse {
719 /**
720 * An array of text that was detected in the input image.
721 */
722 TextDetections?: TextDetectionList;
723 }
724 export interface Emotion {
725 /**
726 * Type of emotion detected.
727 */
728 Type?: EmotionName;
729 /**
730 * Level of confidence in the determination.
731 */
732 Confidence?: Percent;
733 }
734 export type EmotionName = "HAPPY"|"SAD"|"ANGRY"|"CONFUSED"|"DISGUSTED"|"SURPRISED"|"CALM"|"UNKNOWN"|"FEAR"|string;
735 export type Emotions = Emotion[];
736 export type ExternalImageId = string;
737 export interface EyeOpen {
738 /**
739 * Boolean value that indicates whether the eyes on the face are open.
740 */
741 Value?: Boolean;
742 /**
743 * Level of confidence in the determination.
744 */
745 Confidence?: Percent;
746 }
747 export interface Eyeglasses {
748 /**
749 * Boolean value that indicates whether the face is wearing eye glasses or not.
750 */
751 Value?: Boolean;
752 /**
753 * Level of confidence in the determination.
754 */
755 Confidence?: Percent;
756 }
757 export interface Face {
758 /**
759 * Unique identifier that Amazon Rekognition assigns to the face.
760 */
761 FaceId?: FaceId;
762 /**
763 * Bounding box of the face.
764 */
765 BoundingBox?: BoundingBox;
766 /**
767 * Unique identifier that Amazon Rekognition assigns to the input image.
768 */
769 ImageId?: ImageId;
770 /**
771 * Identifier that you assign to all the faces in the input image.
772 */
773 ExternalImageId?: ExternalImageId;
774 /**
775 * Confidence level that the bounding box contains a face (and not a different object such as a tree).
776 */
777 Confidence?: Percent;
778 }
779 export type FaceAttributes = "DEFAULT"|"ALL"|string;
780 export interface FaceDetail {
781 /**
782 * Bounding box of the face. Default attribute.
783 */
784 BoundingBox?: BoundingBox;
785 /**
786 * The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
787 */
788 AgeRange?: AgeRange;
789 /**
790 * Indicates whether or not the face is smiling, and the confidence level in the determination.
791 */
792 Smile?: Smile;
793 /**
794 * Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
795 */
796 Eyeglasses?: Eyeglasses;
797 /**
798 * Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
799 */
800 Sunglasses?: Sunglasses;
801 /**
802 * Gender of the face and the confidence level in the determination.
803 */
804 Gender?: Gender;
805 /**
806 * Indicates whether or not the face has a beard, and the confidence level in the determination.
807 */
808 Beard?: Beard;
809 /**
810 * Indicates whether or not the face has a mustache, and the confidence level in the determination.
811 */
812 Mustache?: Mustache;
813 /**
814 * Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
815 */
816 EyesOpen?: EyeOpen;
817 /**
818 * Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
819 */
820 MouthOpen?: MouthOpen;
821 /**
822 * 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.
823 */
824 Emotions?: Emotions;
825 /**
826 * Indicates the location of landmarks on the face. Default attribute.
827 */
828 Landmarks?: Landmarks;
829 /**
830 * Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
831 */
832 Pose?: Pose;
833 /**
834 * Identifies image brightness and sharpness. Default attribute.
835 */
836 Quality?: ImageQuality;
837 /**
838 * Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
839 */
840 Confidence?: Percent;
841 }
842 export type FaceDetailList = FaceDetail[];
843 export interface FaceDetection {
844 /**
845 * Time, in milliseconds from the start of the video, that the face was detected.
846 */
847 Timestamp?: Timestamp;
848 /**
849 * The face properties for the detected face.
850 */
851 Face?: FaceDetail;
852 }
853 export type FaceDetections = FaceDetection[];
854 export type FaceId = string;
855 export type FaceIdList = FaceId[];
856 export type FaceList = Face[];
857 export interface FaceMatch {
858 /**
859 * Confidence in the match of this face with the input face.
860 */
861 Similarity?: Percent;
862 /**
863 * Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
864 */
865 Face?: Face;
866 }
867 export type FaceMatchList = FaceMatch[];
868 export type FaceModelVersionList = String[];
869 export interface FaceRecord {
870 /**
871 * Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
872 */
873 Face?: Face;
874 /**
875 * Structure containing attributes of the face that the algorithm detected.
876 */
877 FaceDetail?: FaceDetail;
878 }
879 export type FaceRecordList = FaceRecord[];
880 export interface FaceSearchSettings {
881 /**
882 * The ID of a collection that contains faces that you want to search for.
883 */
884 CollectionId?: CollectionId;
885 /**
886 * Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.
887 */
888 FaceMatchThreshold?: Percent;
889 }
890 export type FaceSearchSortBy = "INDEX"|"TIMESTAMP"|string;
891 export type Float = number;
892 export interface Gender {
893 /**
894 * Gender of the face.
895 */
896 Value?: GenderType;
897 /**
898 * Level of confidence in the determination.
899 */
900 Confidence?: Percent;
901 }
902 export type GenderType = "Male"|"Female"|string;
903 export interface Geometry {
904 /**
905 * An axis-aligned coarse representation of the detected text's location on the image.
906 */
907 BoundingBox?: BoundingBox;
908 /**
909 * Within the bounding box, a fine-grained polygon around the detected text.
910 */
911 Polygon?: Polygon;
912 }
913 export interface GetCelebrityInfoRequest {
914 /**
915 * The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
916 */
917 Id: RekognitionUniqueId;
918 }
919 export interface GetCelebrityInfoResponse {
920 /**
921 * An array of URLs pointing to additional celebrity information.
922 */
923 Urls?: Urls;
924 /**
925 * The name of the celebrity.
926 */
927 Name?: String;
928 }
929 export interface GetCelebrityRecognitionRequest {
930 /**
931 * Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.
932 */
933 JobId: JobId;
934 /**
935 * 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.
936 */
937 MaxResults?: MaxResults;
938 /**
939 * 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.
940 */
941 NextToken?: PaginationToken;
942 /**
943 * 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.
944 */
945 SortBy?: CelebrityRecognitionSortBy;
946 }
947 export interface GetCelebrityRecognitionResponse {
948 /**
949 * The current status of the celebrity recognition job.
950 */
951 JobStatus?: VideoJobStatus;
952 /**
953 * If the job fails, StatusMessage provides a descriptive error message.
954 */
955 StatusMessage?: StatusMessage;
956 /**
957 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
958 */
959 VideoMetadata?: VideoMetadata;
960 /**
961 * 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.
962 */
963 NextToken?: PaginationToken;
964 /**
965 * Array of celebrities recognized in the video.
966 */
967 Celebrities?: CelebrityRecognitions;
968 }
969 export interface GetContentModerationRequest {
970 /**
971 * The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.
972 */
973 JobId: JobId;
974 /**
975 * 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.
976 */
977 MaxResults?: MaxResults;
978 /**
979 * 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.
980 */
981 NextToken?: PaginationToken;
982 /**
983 * 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.
984 */
985 SortBy?: ContentModerationSortBy;
986 }
987 export interface GetContentModerationResponse {
988 /**
989 * The current status of the unsafe content analysis job.
990 */
991 JobStatus?: VideoJobStatus;
992 /**
993 * If the job fails, StatusMessage provides a descriptive error message.
994 */
995 StatusMessage?: StatusMessage;
996 /**
997 * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.
998 */
999 VideoMetadata?: VideoMetadata;
1000 /**
1001 * The detected unsafe content labels and the time(s) they were detected.
1002 */
1003 ModerationLabels?: ContentModerationDetections;
1004 /**
1005 * 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.
1006 */
1007 NextToken?: PaginationToken;
1008 /**
1009 * Version number of the moderation detection model that was used to detect unsafe content.
1010 */
1011 ModerationModelVersion?: String;
1012 }
1013 export interface GetFaceDetectionRequest {
1014 /**
1015 * Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.
1016 */
1017 JobId: JobId;
1018 /**
1019 * 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.
1020 */
1021 MaxResults?: MaxResults;
1022 /**
1023 * 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.
1024 */
1025 NextToken?: PaginationToken;
1026 }
1027 export interface GetFaceDetectionResponse {
1028 /**
1029 * The current status of the face detection job.
1030 */
1031 JobStatus?: VideoJobStatus;
1032 /**
1033 * If the job fails, StatusMessage provides a descriptive error message.
1034 */
1035 StatusMessage?: StatusMessage;
1036 /**
1037 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
1038 */
1039 VideoMetadata?: VideoMetadata;
1040 /**
1041 * 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.
1042 */
1043 NextToken?: PaginationToken;
1044 /**
1045 * 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.
1046 */
1047 Faces?: FaceDetections;
1048 }
1049 export interface GetFaceSearchRequest {
1050 /**
1051 * The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.
1052 */
1053 JobId: JobId;
1054 /**
1055 * 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.
1056 */
1057 MaxResults?: MaxResults;
1058 /**
1059 * 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.
1060 */
1061 NextToken?: PaginationToken;
1062 /**
1063 * 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.
1064 */
1065 SortBy?: FaceSearchSortBy;
1066 }
1067 export interface GetFaceSearchResponse {
1068 /**
1069 * The current status of the face search job.
1070 */
1071 JobStatus?: VideoJobStatus;
1072 /**
1073 * If the job fails, StatusMessage provides a descriptive error message.
1074 */
1075 StatusMessage?: StatusMessage;
1076 /**
1077 * 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.
1078 */
1079 NextToken?: PaginationToken;
1080 /**
1081 * Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
1082 */
1083 VideoMetadata?: VideoMetadata;
1084 /**
1085 * 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.
1086 */
1087 Persons?: PersonMatches;
1088 }
1089 export interface GetLabelDetectionRequest {
1090 /**
1091 * Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.
1092 */
1093 JobId: JobId;
1094 /**
1095 * 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.
1096 */
1097 MaxResults?: MaxResults;
1098 /**
1099 * 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.
1100 */
1101 NextToken?: PaginationToken;
1102 /**
1103 * 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.
1104 */
1105 SortBy?: LabelDetectionSortBy;
1106 }
1107 export interface GetLabelDetectionResponse {
1108 /**
1109 * The current status of the label detection job.
1110 */
1111 JobStatus?: VideoJobStatus;
1112 /**
1113 * If the job fails, StatusMessage provides a descriptive error message.
1114 */
1115 StatusMessage?: StatusMessage;
1116 /**
1117 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
1118 */
1119 VideoMetadata?: VideoMetadata;
1120 /**
1121 * 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.
1122 */
1123 NextToken?: PaginationToken;
1124 /**
1125 * 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.
1126 */
1127 Labels?: LabelDetections;
1128 /**
1129 * Version number of the label detection model that was used to detect labels.
1130 */
1131 LabelModelVersion?: String;
1132 }
1133 export interface GetPersonTrackingRequest {
1134 /**
1135 * The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.
1136 */
1137 JobId: JobId;
1138 /**
1139 * 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.
1140 */
1141 MaxResults?: MaxResults;
1142 /**
1143 * 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.
1144 */
1145 NextToken?: PaginationToken;
1146 /**
1147 * 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.
1148 */
1149 SortBy?: PersonTrackingSortBy;
1150 }
1151 export interface GetPersonTrackingResponse {
1152 /**
1153 * The current status of the person tracking job.
1154 */
1155 JobStatus?: VideoJobStatus;
1156 /**
1157 * If the job fails, StatusMessage provides a descriptive error message.
1158 */
1159 StatusMessage?: StatusMessage;
1160 /**
1161 * Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
1162 */
1163 VideoMetadata?: VideoMetadata;
1164 /**
1165 * 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.
1166 */
1167 NextToken?: PaginationToken;
1168 /**
1169 * 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.
1170 */
1171 Persons?: PersonDetections;
1172 }
1173 export interface Image {
1174 /**
1175 * Blob of image bytes up to 5 MBs.
1176 */
1177 Bytes?: ImageBlob;
1178 /**
1179 * Identifies an S3 object as the image source.
1180 */
1181 S3Object?: S3Object;
1182 }
1183 export type ImageBlob = Buffer|Uint8Array|Blob|string;
1184 export type ImageId = string;
1185 export interface ImageQuality {
1186 /**
1187 * Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
1188 */
1189 Brightness?: Float;
1190 /**
1191 * Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
1192 */
1193 Sharpness?: Float;
1194 }
1195 export interface IndexFacesRequest {
1196 /**
1197 * The ID of an existing collection to which you want to add the faces that are detected in the input images.
1198 */
1199 CollectionId: CollectionId;
1200 /**
1201 * 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.
1202 */
1203 Image: Image;
1204 /**
1205 * The ID you want to assign to all the faces detected in the image.
1206 */
1207 ExternalImageId?: ExternalImageId;
1208 /**
1209 * 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).
1210 */
1211 DetectionAttributes?: Attributes;
1212 /**
1213 * 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.
1214 */
1215 MaxFaces?: MaxFacesToIndex;
1216 /**
1217 * A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. 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 AUTO. To use quality filtering, the collection you are using must be associated with version 3 of the face model.
1218 */
1219 QualityFilter?: QualityFilter;
1220 }
1221 export interface IndexFacesResponse {
1222 /**
1223 * 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.
1224 */
1225 FaceRecords?: FaceRecordList;
1226 /**
1227 * 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.
1228 */
1229 OrientationCorrection?: OrientationCorrection;
1230 /**
1231 * The version number of the face detection model that's associated with the input collection (CollectionId).
1232 */
1233 FaceModelVersion?: String;
1234 /**
1235 * 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.
1236 */
1237 UnindexedFaces?: UnindexedFaces;
1238 }
1239 export interface Instance {
1240 /**
1241 * The position of the label instance on the image.
1242 */
1243 BoundingBox?: BoundingBox;
1244 /**
1245 * The confidence that Amazon Rekognition has in the accuracy of the bounding box.
1246 */
1247 Confidence?: Percent;
1248 }
1249 export type Instances = Instance[];
1250 export type JobId = string;
1251 export type JobTag = string;
1252 export type KinesisDataArn = string;
1253 export interface KinesisDataStream {
1254 /**
1255 * ARN of the output Amazon Kinesis Data Streams stream.
1256 */
1257 Arn?: KinesisDataArn;
1258 }
1259 export type KinesisVideoArn = string;
1260 export interface KinesisVideoStream {
1261 /**
1262 * ARN of the Kinesis video stream stream that streams the source video.
1263 */
1264 Arn?: KinesisVideoArn;
1265 }
1266 export interface Label {
1267 /**
1268 * The name (label) of the object or scene.
1269 */
1270 Name?: String;
1271 /**
1272 * Level of confidence.
1273 */
1274 Confidence?: Percent;
1275 /**
1276 * 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.
1277 */
1278 Instances?: Instances;
1279 /**
1280 * The parent labels for a label. The response includes all ancestor labels.
1281 */
1282 Parents?: Parents;
1283 }
1284 export interface LabelDetection {
1285 /**
1286 * Time, in milliseconds from the start of the video, that the label was detected.
1287 */
1288 Timestamp?: Timestamp;
1289 /**
1290 * Details about the detected label.
1291 */
1292 Label?: Label;
1293 }
1294 export type LabelDetectionSortBy = "NAME"|"TIMESTAMP"|string;
1295 export type LabelDetections = LabelDetection[];
1296 export type Labels = Label[];
1297 export interface Landmark {
1298 /**
1299 * Type of landmark.
1300 */
1301 Type?: LandmarkType;
1302 /**
1303 * 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.
1304 */
1305 X?: Float;
1306 /**
1307 * 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.
1308 */
1309 Y?: Float;
1310 }
1311 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;
1312 export type Landmarks = Landmark[];
1313 export interface ListCollectionsRequest {
1314 /**
1315 * Pagination token from the previous response.
1316 */
1317 NextToken?: PaginationToken;
1318 /**
1319 * Maximum number of collection IDs to return.
1320 */
1321 MaxResults?: PageSize;
1322 }
1323 export interface ListCollectionsResponse {
1324 /**
1325 * An array of collection IDs.
1326 */
1327 CollectionIds?: CollectionIdList;
1328 /**
1329 * 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.
1330 */
1331 NextToken?: PaginationToken;
1332 /**
1333 * 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].
1334 */
1335 FaceModelVersions?: FaceModelVersionList;
1336 }
1337 export interface ListFacesRequest {
1338 /**
1339 * ID of the collection from which to list the faces.
1340 */
1341 CollectionId: CollectionId;
1342 /**
1343 * 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.
1344 */
1345 NextToken?: PaginationToken;
1346 /**
1347 * Maximum number of faces to return.
1348 */
1349 MaxResults?: PageSize;
1350 }
1351 export interface ListFacesResponse {
1352 /**
1353 * An array of Face objects.
1354 */
1355 Faces?: FaceList;
1356 /**
1357 * 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.
1358 */
1359 NextToken?: String;
1360 /**
1361 * Version number of the face detection model associated with the input collection (CollectionId).
1362 */
1363 FaceModelVersion?: String;
1364 }
1365 export interface ListStreamProcessorsRequest {
1366 /**
1367 * 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.
1368 */
1369 NextToken?: PaginationToken;
1370 /**
1371 * Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
1372 */
1373 MaxResults?: MaxResults;
1374 }
1375 export interface ListStreamProcessorsResponse {
1376 /**
1377 * 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.
1378 */
1379 NextToken?: PaginationToken;
1380 /**
1381 * List of stream processors that you have created.
1382 */
1383 StreamProcessors?: StreamProcessorList;
1384 }
1385 export type MaxFaces = number;
1386 export type MaxFacesToIndex = number;
1387 export type MaxResults = number;
1388 export interface ModerationLabel {
1389 /**
1390 * 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.
1391 */
1392 Confidence?: Percent;
1393 /**
1394 * The label name for the type of unsafe content detected in the image.
1395 */
1396 Name?: String;
1397 /**
1398 * The name for the parent label. Labels at the top level of the hierarchy have the parent label "".
1399 */
1400 ParentName?: String;
1401 }
1402 export type ModerationLabels = ModerationLabel[];
1403 export interface MouthOpen {
1404 /**
1405 * Boolean value that indicates whether the mouth on the face is open or not.
1406 */
1407 Value?: Boolean;
1408 /**
1409 * Level of confidence in the determination.
1410 */
1411 Confidence?: Percent;
1412 }
1413 export interface Mustache {
1414 /**
1415 * Boolean value that indicates whether the face has mustache or not.
1416 */
1417 Value?: Boolean;
1418 /**
1419 * Level of confidence in the determination.
1420 */
1421 Confidence?: Percent;
1422 }
1423 export interface NotificationChannel {
1424 /**
1425 * The Amazon SNS topic to which Amazon Rekognition to posts the completion status.
1426 */
1427 SNSTopicArn: SNSTopicArn;
1428 /**
1429 * The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.
1430 */
1431 RoleArn: RoleArn;
1432 }
1433 export type OrientationCorrection = "ROTATE_0"|"ROTATE_90"|"ROTATE_180"|"ROTATE_270"|string;
1434 export type PageSize = number;
1435 export type PaginationToken = string;
1436 export interface Parent {
1437 /**
1438 * The name of the parent label.
1439 */
1440 Name?: String;
1441 }
1442 export type Parents = Parent[];
1443 export type Percent = number;
1444 export interface PersonDetail {
1445 /**
1446 * 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.
1447 */
1448 Index?: PersonIndex;
1449 /**
1450 * Bounding box around the detected person.
1451 */
1452 BoundingBox?: BoundingBox;
1453 /**
1454 * Face details for the detected person.
1455 */
1456 Face?: FaceDetail;
1457 }
1458 export interface PersonDetection {
1459 /**
1460 * The time, in milliseconds from the start of the video, that the person's path was tracked.
1461 */
1462 Timestamp?: Timestamp;
1463 /**
1464 * Details about a person whose path was tracked in a video.
1465 */
1466 Person?: PersonDetail;
1467 }
1468 export type PersonDetections = PersonDetection[];
1469 export type PersonIndex = number;
1470 export interface PersonMatch {
1471 /**
1472 * The time, in milliseconds from the beginning of the video, that the person was matched in the video.
1473 */
1474 Timestamp?: Timestamp;
1475 /**
1476 * Information about the matched person.
1477 */
1478 Person?: PersonDetail;
1479 /**
1480 * Information about the faces in the input collection that match the face of a person in the video.
1481 */
1482 FaceMatches?: FaceMatchList;
1483 }
1484 export type PersonMatches = PersonMatch[];
1485 export type PersonTrackingSortBy = "INDEX"|"TIMESTAMP"|string;
1486 export interface Point {
1487 /**
1488 * The value of the X coordinate for a point on a Polygon.
1489 */
1490 X?: Float;
1491 /**
1492 * The value of the Y coordinate for a point on a Polygon.
1493 */
1494 Y?: Float;
1495 }
1496 export type Polygon = Point[];
1497 export interface Pose {
1498 /**
1499 * Value representing the face rotation on the roll axis.
1500 */
1501 Roll?: Degree;
1502 /**
1503 * Value representing the face rotation on the yaw axis.
1504 */
1505 Yaw?: Degree;
1506 /**
1507 * Value representing the face rotation on the pitch axis.
1508 */
1509 Pitch?: Degree;
1510 }
1511 export type QualityFilter = "NONE"|"AUTO"|string;
1512 export type Reason = "EXCEEDS_MAX_FACES"|"EXTREME_POSE"|"LOW_BRIGHTNESS"|"LOW_SHARPNESS"|"LOW_CONFIDENCE"|"SMALL_BOUNDING_BOX"|string;
1513 export type Reasons = Reason[];
1514 export interface RecognizeCelebritiesRequest {
1515 /**
1516 * 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.
1517 */
1518 Image: Image;
1519 }
1520 export interface RecognizeCelebritiesResponse {
1521 /**
1522 * Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.
1523 */
1524 CelebrityFaces?: CelebrityList;
1525 /**
1526 * Details about each unrecognized face in the image.
1527 */
1528 UnrecognizedFaces?: ComparedFaceList;
1529 /**
1530 * 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.
1531 */
1532 OrientationCorrection?: OrientationCorrection;
1533 }
1534 export type RekognitionUniqueId = string;
1535 export type RoleArn = string;
1536 export type S3Bucket = string;
1537 export interface S3Object {
1538 /**
1539 * Name of the S3 bucket.
1540 */
1541 Bucket?: S3Bucket;
1542 /**
1543 * S3 object key name.
1544 */
1545 Name?: S3ObjectName;
1546 /**
1547 * If the bucket is versioning enabled, you can specify the object version.
1548 */
1549 Version?: S3ObjectVersion;
1550 }
1551 export type S3ObjectName = string;
1552 export type S3ObjectVersion = string;
1553 export type SNSTopicArn = string;
1554 export interface SearchFacesByImageRequest {
1555 /**
1556 * ID of the collection to search.
1557 */
1558 CollectionId: CollectionId;
1559 /**
1560 * 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.
1561 */
1562 Image: Image;
1563 /**
1564 * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
1565 */
1566 MaxFaces?: MaxFaces;
1567 /**
1568 * (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%.
1569 */
1570 FaceMatchThreshold?: Percent;
1571 }
1572 export interface SearchFacesByImageResponse {
1573 /**
1574 * The bounding box around the face in the input image that Amazon Rekognition used for the search.
1575 */
1576 SearchedFaceBoundingBox?: BoundingBox;
1577 /**
1578 * The level of confidence that the searchedFaceBoundingBox, contains a face.
1579 */
1580 SearchedFaceConfidence?: Percent;
1581 /**
1582 * An array of faces that match the input face, along with the confidence in the match.
1583 */
1584 FaceMatches?: FaceMatchList;
1585 /**
1586 * Version number of the face detection model associated with the input collection (CollectionId).
1587 */
1588 FaceModelVersion?: String;
1589 }
1590 export interface SearchFacesRequest {
1591 /**
1592 * ID of the collection the face belongs to.
1593 */
1594 CollectionId: CollectionId;
1595 /**
1596 * ID of a face to find matches for in the collection.
1597 */
1598 FaceId: FaceId;
1599 /**
1600 * Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
1601 */
1602 MaxFaces?: MaxFaces;
1603 /**
1604 * 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%.
1605 */
1606 FaceMatchThreshold?: Percent;
1607 }
1608 export interface SearchFacesResponse {
1609 /**
1610 * ID of the face that was searched for matches in a collection.
1611 */
1612 SearchedFaceId?: FaceId;
1613 /**
1614 * An array of faces that matched the input face, along with the confidence in the match.
1615 */
1616 FaceMatches?: FaceMatchList;
1617 /**
1618 * Version number of the face detection model associated with the input collection (CollectionId).
1619 */
1620 FaceModelVersion?: String;
1621 }
1622 export interface Smile {
1623 /**
1624 * Boolean value that indicates whether the face is smiling or not.
1625 */
1626 Value?: Boolean;
1627 /**
1628 * Level of confidence in the determination.
1629 */
1630 Confidence?: Percent;
1631 }
1632 export interface StartCelebrityRecognitionRequest {
1633 /**
1634 * The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
1635 */
1636 Video: Video;
1637 /**
1638 * 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.
1639 */
1640 ClientRequestToken?: ClientRequestToken;
1641 /**
1642 * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
1643 */
1644 NotificationChannel?: NotificationChannel;
1645 /**
1646 * 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.
1647 */
1648 JobTag?: JobTag;
1649 }
1650 export interface StartCelebrityRecognitionResponse {
1651 /**
1652 * The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.
1653 */
1654 JobId?: JobId;
1655 }
1656 export interface StartContentModerationRequest {
1657 /**
1658 * The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.
1659 */
1660 Video: Video;
1661 /**
1662 * 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.
1663 */
1664 MinConfidence?: Percent;
1665 /**
1666 * 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.
1667 */
1668 ClientRequestToken?: ClientRequestToken;
1669 /**
1670 * The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the unsafe content analysis to.
1671 */
1672 NotificationChannel?: NotificationChannel;
1673 /**
1674 * 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.
1675 */
1676 JobTag?: JobTag;
1677 }
1678 export interface StartContentModerationResponse {
1679 /**
1680 * The identifier for the unsafe content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.
1681 */
1682 JobId?: JobId;
1683 }
1684 export interface StartFaceDetectionRequest {
1685 /**
1686 * The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
1687 */
1688 Video: Video;
1689 /**
1690 * 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.
1691 */
1692 ClientRequestToken?: ClientRequestToken;
1693 /**
1694 * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
1695 */
1696 NotificationChannel?: NotificationChannel;
1697 /**
1698 * 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.
1699 */
1700 FaceAttributes?: FaceAttributes;
1701 /**
1702 * 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.
1703 */
1704 JobTag?: JobTag;
1705 }
1706 export interface StartFaceDetectionResponse {
1707 /**
1708 * The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.
1709 */
1710 JobId?: JobId;
1711 }
1712 export interface StartFaceSearchRequest {
1713 /**
1714 * The video you want to search. The video must be stored in an Amazon S3 bucket.
1715 */
1716 Video: Video;
1717 /**
1718 * 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.
1719 */
1720 ClientRequestToken?: ClientRequestToken;
1721 /**
1722 * 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%.
1723 */
1724 FaceMatchThreshold?: Percent;
1725 /**
1726 * ID of the collection that contains the faces you want to search for.
1727 */
1728 CollectionId: CollectionId;
1729 /**
1730 * The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
1731 */
1732 NotificationChannel?: NotificationChannel;
1733 /**
1734 * 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.
1735 */
1736 JobTag?: JobTag;
1737 }
1738 export interface StartFaceSearchResponse {
1739 /**
1740 * The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.
1741 */
1742 JobId?: JobId;
1743 }
1744 export interface StartLabelDetectionRequest {
1745 /**
1746 * The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
1747 */
1748 Video: Video;
1749 /**
1750 * 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.
1751 */
1752 ClientRequestToken?: ClientRequestToken;
1753 /**
1754 * 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.
1755 */
1756 MinConfidence?: Percent;
1757 /**
1758 * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
1759 */
1760 NotificationChannel?: NotificationChannel;
1761 /**
1762 * 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.
1763 */
1764 JobTag?: JobTag;
1765 }
1766 export interface StartLabelDetectionResponse {
1767 /**
1768 * The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.
1769 */
1770 JobId?: JobId;
1771 }
1772 export interface StartPersonTrackingRequest {
1773 /**
1774 * The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
1775 */
1776 Video: Video;
1777 /**
1778 * 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.
1779 */
1780 ClientRequestToken?: ClientRequestToken;
1781 /**
1782 * The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
1783 */
1784 NotificationChannel?: NotificationChannel;
1785 /**
1786 * 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.
1787 */
1788 JobTag?: JobTag;
1789 }
1790 export interface StartPersonTrackingResponse {
1791 /**
1792 * The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.
1793 */
1794 JobId?: JobId;
1795 }
1796 export interface StartStreamProcessorRequest {
1797 /**
1798 * The name of the stream processor to start processing.
1799 */
1800 Name: StreamProcessorName;
1801 }
1802 export interface StartStreamProcessorResponse {
1803 }
1804 export type StatusMessage = string;
1805 export interface StopStreamProcessorRequest {
1806 /**
1807 * The name of a stream processor created by CreateStreamProcessor.
1808 */
1809 Name: StreamProcessorName;
1810 }
1811 export interface StopStreamProcessorResponse {
1812 }
1813 export interface StreamProcessor {
1814 /**
1815 * Name of the Amazon Rekognition stream processor.
1816 */
1817 Name?: StreamProcessorName;
1818 /**
1819 * Current status of the Amazon Rekognition stream processor.
1820 */
1821 Status?: StreamProcessorStatus;
1822 }
1823 export type StreamProcessorArn = string;
1824 export interface StreamProcessorInput {
1825 /**
1826 * The Kinesis video stream input stream for the source streaming video.
1827 */
1828 KinesisVideoStream?: KinesisVideoStream;
1829 }
1830 export type StreamProcessorList = StreamProcessor[];
1831 export type StreamProcessorName = string;
1832 export interface StreamProcessorOutput {
1833 /**
1834 * The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
1835 */
1836 KinesisDataStream?: KinesisDataStream;
1837 }
1838 export interface StreamProcessorSettings {
1839 /**
1840 * Face search settings to use on a streaming video.
1841 */
1842 FaceSearch?: FaceSearchSettings;
1843 }
1844 export type StreamProcessorStatus = "STOPPED"|"STARTING"|"RUNNING"|"FAILED"|"STOPPING"|string;
1845 export type String = string;
1846 export interface Sunglasses {
1847 /**
1848 * Boolean value that indicates whether the face is wearing sunglasses or not.
1849 */
1850 Value?: Boolean;
1851 /**
1852 * Level of confidence in the determination.
1853 */
1854 Confidence?: Percent;
1855 }
1856 export interface TextDetection {
1857 /**
1858 * The word or line of text recognized by Amazon Rekognition.
1859 */
1860 DetectedText?: String;
1861 /**
1862 * The type of text that was detected.
1863 */
1864 Type?: TextTypes;
1865 /**
1866 * The identifier for the detected text. The identifier is only unique for a single call to DetectText.
1867 */
1868 Id?: UInteger;
1869 /**
1870 * 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.
1871 */
1872 ParentId?: UInteger;
1873 /**
1874 * The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
1875 */
1876 Confidence?: Percent;
1877 /**
1878 * 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.
1879 */
1880 Geometry?: Geometry;
1881 }
1882 export type TextDetectionList = TextDetection[];
1883 export type TextTypes = "LINE"|"WORD"|string;
1884 export type Timestamp = number;
1885 export type UInteger = number;
1886 export type ULong = number;
1887 export interface UnindexedFace {
1888 /**
1889 * 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.
1890 */
1891 Reasons?: Reasons;
1892 /**
1893 * The structure that contains attributes of a face that IndexFacesdetected, but didn't index.
1894 */
1895 FaceDetail?: FaceDetail;
1896 }
1897 export type UnindexedFaces = UnindexedFace[];
1898 export type Url = string;
1899 export type Urls = Url[];
1900 export interface Video {
1901 /**
1902 * The Amazon S3 bucket name and file name for the video.
1903 */
1904 S3Object?: S3Object;
1905 }
1906 export type VideoJobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
1907 export interface VideoMetadata {
1908 /**
1909 * Type of compression used in the analyzed video.
1910 */
1911 Codec?: String;
1912 /**
1913 * Length of the video in milliseconds.
1914 */
1915 DurationMillis?: ULong;
1916 /**
1917 * Format of the analyzed video. Possible values are MP4, MOV and AVI.
1918 */
1919 Format?: String;
1920 /**
1921 * Number of frames per second in the video.
1922 */
1923 FrameRate?: Float;
1924 /**
1925 * Vertical pixel dimension of the video.
1926 */
1927 FrameHeight?: ULong;
1928 /**
1929 * Horizontal pixel dimension of the video.
1930 */
1931 FrameWidth?: ULong;
1932 }
1933 /**
1934 * 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.
1935 */
1936 export type apiVersion = "2016-06-27"|"latest"|string;
1937 export interface ClientApiVersions {
1938 /**
1939 * 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.
1940 */
1941 apiVersion?: apiVersion;
1942 }
1943 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1944 /**
1945 * Contains interfaces for use with the Rekognition client.
1946 */
1947 export import Types = Rekognition;
1948}
1949export = Rekognition;