Associates one or more faces with an existing UserID. Takes an array of FaceIds. Each FaceId that are present in the FaceIds list is associated with the provided UserID. The maximum number of total FaceIds per UserID is 100.
The UserMatchThreshold parameter specifies the minimum user match confidence required for the face to be associated with a UserID that has at least one FaceID already associated. This ensures that the FaceIds are associated with the right UserID. The value ranges from 0-100 and default value is 75.
If successful, an array of AssociatedFace objects containing the associated FaceIds is returned. If a given face is already associated with the given UserID, it will be ignored and will not be returned in the response. If a given face is already associated to a different UserID, isn't found in the collection, doesn’t meet the UserMatchThreshold, or there are already 100 faces associated with the UserID, it will be returned as part of an array of UnsuccessfulFaceAssociations.
The UserStatus reflects the status of an operation which updates a UserID representation with a list of given faces. The UserStatus can be:
ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
CREATED - A UserID has been created, but has no FaceID(s) associated with it.
UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.
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.
CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action.
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, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.
By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter.
CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.
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.
This operation applies only to Amazon Rekognition Custom Labels.
Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service.
To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account.
For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.
If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
Copying project versions is supported only for Custom Labels models.
To copy a model, the destination project, source project, and source model version must already exist.
Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED.
This operation requires permissions to perform the rekognition:CopyProjectVersion action.
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. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.
This operation applies only to Amazon Rekognition Custom Labels.
Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.
To create a training dataset for a project, specify TRAIN for the value of DatasetType. To create the test dataset for a project, specify TEST for the value of DatasetType.
The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.
To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.
Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.
For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.
This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.
This API operation initiates a Face Liveness session. It returns a SessionId, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session.
You can use the OutputConfig option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead.
You can use AuditImagesLimit to limit the number of audit images returned when GetFaceLivenessSessionResults is called. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.
Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the rekognition:CreateProject action.
Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the project version.
The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.
This operation requires permissions to perform the rekognition:CreateProjectVersion action.
The following applies only to projects with Amazon Rekognition Custom Labels as the chosen feature:
You can train a model in a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.
If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.
Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.
Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.
Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.
If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream for receiving the output. You must use the FaceSearch option in Settings, specifying the collection that contains the faces you want to recognize. After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing.
If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (Input), Amazon S3 bucket information (Output), and an Amazon SNS topic ARN (NotificationChannel). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want to detect by using the ConnectedHome option in settings, and selecting one of the following: PERSON, PET, PACKAGE, ALL You can also specify where in the frame you want Amazon Rekognition to monitor with RegionsOfInterest. When you run the StartStreamProcessor operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.
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.
This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.
Creates a new User within a collection specified by CollectionId. Takes UserId as a parameter, which is a user provided ID which should be unique within the collection. The provided UserId will alias the system generated UUID to make the UserId more user friendly.
Uses a ClientToken, an idempotency token that ensures a call to CreateUser completes only once. If the value is not supplied, the AWS SDK generates an idempotency token for the requests. This prevents retries after a network error results from making multiple CreateUser calls.
Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection.
This operation requires permissions to perform the rekognition:DeleteCollection action.
This operation applies only to Amazon Rekognition Custom Labels.
Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.
You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).
This operation requires permissions to perform the rekognition:DeleteDataset action.
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.
Deletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, see DeleteProjectVersion.
DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response. Be aware that deleting a given project will also delete any ProjectPolicies associated with that project.
This operation requires permissions to perform the rekognition:DeleteProject action.
This operation applies only to Amazon Rekognition Custom Labels.
Deletes an existing project policy.
To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.
This operation requires permissions to perform the rekognition:DeleteProjectPolicy action.
Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.
You can't delete a project version if it is running or if it is training. To check the status of a project version, use the Status field returned from DescribeProjectVersions. To stop a project version call StopProjectVersion. If the project version is training, wait until it finishes.
This operation requires permissions to perform the rekognition:DeleteProjectVersion action.
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.
Deletes the specified UserID within the collection. Faces that are associated with the UserID are disassociated from the UserID before deleting the specified UserID. If the specified Collection or UserID is already deleted or not found, a ResourceNotFoundException will be thrown. If the action is successful with a 200 response, an empty HTTP body is returned.
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.
" }, "DescribeDataset": { "name": "DescribeDataset", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeDatasetRequest" }, "output": { "shape": "DescribeDatasetResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "InvalidParameterException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "This operation applies only to Amazon Rekognition Custom Labels.
Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.
This operation requires permissions to perform the rekognition:DescribeDataset action.
Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in ProjectVersionArns. If you don't specify a value, descriptions for all model/adapter versions in the project are returned.
This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
Gets information about your Rekognition projects.
This operation requires permissions to perform the rekognition:DescribeProjects action.
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.
" }, "DetectCustomLabels": { "name": "DetectCustomLabels", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetectCustomLabelsRequest" }, "output": { "shape": "DetectCustomLabelsResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "ResourceNotReadyException" }, { "shape": "InvalidS3ObjectException" }, { "shape": "InvalidParameterException" }, { "shape": "ImageTooLargeException" }, { "shape": "LimitExceededException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "InvalidImageFormatException" } ], "documentation": "This operation applies only to Amazon Rekognition Custom Labels.
Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
You specify which version of a model version to use by using the ProjectVersionArn input parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry). Note that for the DetectCustomLabelsLabels operation, Polygons are not returned in the Geometry section of the response.
To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectCustomLabels action.
For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
" }, "DetectFaces": { "name": "DetectFaces", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DetectFacesRequest" }, "output": { "shape": "DetectFacesResponse" }, "errors": [ { "shape": "InvalidS3ObjectException" }, { "shape": "InvalidParameterException" }, { "shape": "ImageTooLargeException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "InvalidImageFormatException" } ], "documentation": "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), pose, presence of facial occlusion, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces action.
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.
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.
Optional Parameters
You can specify one or both of the GENERAL_LABELS and IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including GENERAL_LABELS will ensure the response includes the labels detected in the input image, while including IMAGE_PROPERTIES will ensure the response includes information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering see Detecting Labels in an Image.
When getting labels, 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. The default and upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a feature type.
Response Elements
For each object, scene, and concept the API returns one or more labels. The API returns the following types of information about labels:
Name - The name of the detected label.
Confidence - The level of confidence in the label assigned to a detected object.
Parents - The ancestor labels for a detected label. DetectLabels 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 includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
Aliases - Possible Aliases for the label.
Categories - The label categories that the detected label belongs to.
BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
The API returns the following information regarding the image, as part of the ImageProperties structure:
Quality - Information about the Sharpness, Brightness, and Contrast of the input image, scored between 0 to 100. Image quality is returned for the entire image, as well as the background and the foreground.
Dominant Color - An array of the dominant colors in the image.
Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.
The list of returned labels will include at least one label for every detected object, along with information about that label. In the following example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object, as well as the confidence in the label:
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
The list of labels can include multiple labels for the same object. 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.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
This is a stateless API operation that doesn't return any data.
This operation requires permissions to perform the rekognition:DetectLabels action.
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.
You can specify an adapter to use when retrieving label predictions by providing a ProjectVersionArn to the ProjectVersion argument.
Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.
Face cover
Hand cover
Head cover
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.
DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.
For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.
You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.
The persons detected as wearing all of the types of PPE that you specify.
The persons detected as not wearing all of the types PPE that you specify.
The persons detected where PPE adornment could not be determined.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
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 script characters that are not separated by spaces. DetectText can detect up to 100 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 Detecting text in the Amazon Rekognition Developer Guide.
" }, "DisassociateFaces": { "name": "DisassociateFaces", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateFacesRequest" }, "output": { "shape": "DisassociateFacesResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "IdempotentParameterMismatchException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ConflictException" } ], "documentation": "Removes the association between a Face supplied in an array of FaceIds and the User. If the User is not present already, then a ResourceNotFound exception is thrown. If successful, an array of faces that are disassociated from the User is returned. If a given face is already disassociated from the given UserID, it will be ignored and not be returned in the response. If a given face is already associated with a different User or not found in the collection it will be returned as part of UnsuccessfulDisassociations. You can remove 1 - 100 face IDs from a user at one time.
This operation applies only to Amazon Rekognition Custom Labels.
Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.
You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.
Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.
This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.
Gets the name and additional information about a celebrity based on their 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 Getting information about a celebrity in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo action.
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. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.
GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies to the detected face instance. 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.
Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.
Amazon Rekognition Video inappropriate or offensive content detection in a stored 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 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 inappropriate, unwanted, or offensive content moderation 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 moderating content in the Amazon Rekognition Developer Guide.
" }, "GetFaceDetection": { "name": "GetFaceDetection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetFaceDetectionRequest" }, "output": { "shape": "GetFaceDetectionResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidPaginationTokenException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "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.
Note that for the GetFaceDetection operation, the returned values for FaceOccluded and EyeDirection will always be \"null\".
Retrieves the results of a specific Face Liveness session. It requires the sessionId as input, which was created using CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence score, a reference image that includes a face bounding box, and audit images that also contain face bounding boxes. The Face Liveness confidence score ranges from 0 to 100.
The number of audit images returned by GetFaceLivenessSessionResults is defined by the AuditImagesLimit paramater when calling CreateFaceLivenessSession. Reference images are always returned when possible.
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.
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. If there is no NAME specified, the default sort is by timestamp.
You can select how results are aggregated by using the AggregateBy input parameter. The default aggregation method is TIMESTAMPS. You can also aggregate by SEGMENTS, which aggregates all instances of labels detected in a given segment.
The returned Labels array may include the following attributes:
Name - The name of the detected label.
Confidence - The level of confidence in the label assigned to a detected object.
Parents - The ancestor labels for a detected label. GetLabelDetection 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 includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
Aliases - Possible Aliases for the label.
Categories - The label categories that the detected label belongs to.
BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
Timestamp - Time, in milliseconds from the start of the video, that the label was detected. For aggregation by SEGMENTS, the StartTimestampMillis, EndTimestampMillis, and DurationMillis structures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same as StartTimestampMillis.
Timestamp and Bounding box information are returned for detected Instances, only if aggregation is done by TIMESTAMPS. If aggregating by SEGMENTS, information about detected instances isn’t returned.
The version of the label model used for the detection is also returned.
Note DominantColors isn't returned for Instances, although it is shown as part of the response in the sample seen below.
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.
If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an \"ERROR\" notification if the job encounters an issue.
" }, "GetMediaAnalysisJob": { "name": "GetMediaAnalysisJob", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetMediaAnalysisJobRequest" }, "output": { "shape": "GetMediaAnalysisJobResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "InternalServerError" }, { "shape": "InvalidParameterException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "ThrottlingException" } ], "documentation": "Retrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.
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.
Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.
Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.
GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.
Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.
Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
" }, "GetTextDetection": { "name": "GetTextDetection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTextDetectionRequest" }, "output": { "shape": "GetTextDetectionResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidPaginationTokenException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.
GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 100 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.
Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.
Detects faces in the input image and adds them to the specified collection.
Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.
For more information, see Adding faces to a collection in the Amazon Rekognition Developer Guide.
To get the number of faces in a collection, call DescribeCollection.
If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.
Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request parameter.
The face is too small compared to the image dimensions.
The face is too blurry.
The image is too dark.
The face has an extreme pose.
The face doesn’t have enough detail to be suitable for face search.
In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request ALL or specific facial attributes (e.g., FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth), facial occlusion, and other facial attributes.
If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
This operation requires permissions to perform the rekognition:IndexFaces action.
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.
This operation applies only to Amazon Rekognition Custom Labels.
Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.
JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.
You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
This operation requires permissions to perform the rekognition:ListDatasetEntries action.
This operation applies only to Amazon Rekognition Custom Labels.
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.
Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.
" }, "ListFaces": { "name": "ListFaces", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListFacesRequest" }, "output": { "shape": "ListFacesResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "InvalidPaginationTokenException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "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.
Returns a list of media analysis jobs. Results are sorted by CreationTimestamp in descending order.
This operation applies only to Amazon Rekognition Custom Labels.
Gets a list of the project policies attached to a project.
To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.
This operation requires permissions to perform the rekognition:ListProjectPolicies action.
Gets a list of stream processors that you have created with CreateStreamProcessor.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" } ], "documentation": "Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
This operation requires permissions to perform the rekognition:ListTagsForResource action.
Returns metadata of the User such as UserID in the specified collection. Anonymous User (to reserve faces without any identity) is not returned as part of this request. The results are sorted by system generated primary key ID. If the response is truncated, NextToken is returned in the response that can be used in the subsequent request to retrieve the next set of identities.
This operation applies only to Amazon Rekognition Custom Labels.
Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A project policy specifies that a trusted AWS account can copy a model version from a trusting AWS account to a project in the trusted AWS account. To copy a model version you use the CopyProjectVersion operation. Only applies to Custom Labels projects.
For more information about the format of a project policy document, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.
The response from PutProjectPolicy is a revision ID for the project policy. You can attach multiple project policies to a project. You can also update an existing project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy. To get a list of project policies attached to a project, call ListProjectPolicies.
You copy a model version by calling CopyProjectVersion.
This operation requires permissions to perform the rekognition:PutProjectPolicy action.
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 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 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.
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.
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.
If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.
The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.
This operation requires permissions to perform the rekognition:SearchFacesByImage action.
Searches for UserIDs within a collection based on a FaceId or UserId. This API can be used to find the closest UserID (with a highest similarity) to associate a face. The request must be provided with either FaceId or UserId. The operation returns an array of UserID that match the FaceId or UserId, ordered by similarity score with the highest similarity first.
Searches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs.
The operation returns an array of UserIDs that match the face in the supplied image, ordered by similarity score with the highest similarity first. It also returns a bounding box for the face found in the input image.
Information about faces detected in the supplied image, but not used for the search, is returned in an array of UnsearchedFace objects. If no valid face is detected in the image, the response will contain an empty UserMatches list and no SearchedFace object.
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.
", "idempotent": true }, "StartContentModeration": { "name": "StartContentModeration", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartContentModerationRequest" }, "output": { "shape": "StartContentModerationResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "IdempotentParameterMismatchException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidS3ObjectException" }, { "shape": "InternalServerError" }, { "shape": "VideoTooLargeException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "LimitExceededException" }, { "shape": "ThrottlingException" } ], "documentation": "Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.
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 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 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 Moderating content in the Amazon Rekognition Developer Guide.
", "idempotent": true }, "StartFaceDetection": { "name": "StartFaceDetection", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartFaceDetectionRequest" }, "output": { "shape": "StartFaceDetectionResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "IdempotentParameterMismatchException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidS3ObjectException" }, { "shape": "InternalServerError" }, { "shape": "VideoTooLargeException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "LimitExceededException" }, { "shape": "ThrottlingException" } ], "documentation": "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.
", "idempotent": true }, "StartFaceSearch": { "name": "StartFaceSearch", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartFaceSearchRequest" }, "output": { "shape": "StartFaceSearchResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "IdempotentParameterMismatchException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidS3ObjectException" }, { "shape": "InternalServerError" }, { "shape": "VideoTooLargeException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "LimitExceededException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" } ], "documentation": "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 Searching stored videos for faces.
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.
Optional Parameters
StartLabelDetection has the GENERAL_LABELS Feature applied by default. This feature allows you to provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering, see Detecting labels in a video.
You can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50.
Initiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.
", "idempotent": true }, "StartPersonTracking": { "name": "StartPersonTracking", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartPersonTrackingRequest" }, "output": { "shape": "StartPersonTrackingResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "IdempotentParameterMismatchException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidS3ObjectException" }, { "shape": "InternalServerError" }, { "shape": "VideoTooLargeException" }, { "shape": "ProvisionedThroughputExceededException" }, { "shape": "LimitExceededException" }, { "shape": "ThrottlingException" } ], "documentation": "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.
This operation applies only to Amazon Rekognition Custom Labels.
Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.
Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.
You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.
This operation requires permissions to perform the rekognition:StartProjectVersion action.
Starts asynchronous detection of segment detection in a stored video.
Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.
To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.
For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.
", "idempotent": true }, "StartStreamProcessor": { "name": "StartStreamProcessor", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartStreamProcessorRequest" }, "output": { "shape": "StartStreamProcessorResponse" }, "errors": [ { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceInUseException" }, { "shape": "ProvisionedThroughputExceededException" } ], "documentation": "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.
If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.
Starts asynchronous detection of text in a stored video.
Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.
To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.
This operation applies only to Amazon Rekognition Custom Labels.
Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. Only applies to Custom Labels projects.
This operation requires permissions to perform the rekognition:StopProjectVersion action.
Stops a running stream processor that was created by CreateStreamProcessor.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ResourceNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "ServiceQuotaExceededException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalServerError" }, { "shape": "ThrottlingException" }, { "shape": "ProvisionedThroughputExceededException" } ], "documentation": "Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.
This operation requires permissions to perform the rekognition:TagResource action.
Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
This operation requires permissions to perform the rekognition:UntagResource action.
This operation applies only to Amazon Rekognition Custom Labels.
Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.
If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.
You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.
UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.
To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.
Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.
This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.
Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.
" } }, "shapes": { "AgeRange": { "type": "structure", "members": { "Low": { "shape": "UInteger", "documentation": "The lowest estimated age.
" }, "High": { "shape": "UInteger", "documentation": "The highest estimated age.
" } }, "documentation": "Structure containing the estimated age range, in years, for a face.
Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might have an estimated range of 4-8.
" }, "Asset": { "type": "structure", "members": { "GroundTruthManifest": { "shape": "GroundTruthManifest" } }, "documentation": "Assets are the images that you use to train and evaluate a model version. Assets can also contain validation information that you use to debug a failed model training.
" }, "Assets": { "type": "list", "member": { "shape": "Asset" } }, "AssociateFacesRequest": { "type": "structure", "required": [ "CollectionId", "UserId", "FaceIds" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection containing the UserID.
" }, "UserId": { "shape": "UserId", "documentation": "The ID for the existing UserID.
" }, "FaceIds": { "shape": "UserFaceIdList", "documentation": "An array of FaceIDs to associate with the UserID.
" }, "UserMatchThreshold": { "shape": "Percent", "documentation": "An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "Idempotent token used to identify the request to AssociateFaces. If you use the same token with multiple AssociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
An array of AssociatedFace objects containing FaceIDs that have been successfully associated with the UserID. Returned if the AssociateFaces action is successful.
" }, "UnsuccessfulFaceAssociations": { "shape": "UnsuccessfulFaceAssociationList", "documentation": "An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully associated along with the reasons. Returned if the AssociateFaces action is successful.
" }, "UserStatus": { "shape": "UserStatus", "documentation": "The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.
" } } }, "AssociatedFace": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "Unique identifier assigned to the face.
" } }, "documentation": "Provides face metadata for the faces that are associated to a specific UserID.
" }, "AssociatedFacesList": { "type": "list", "member": { "shape": "AssociatedFace" }, "max": 100, "min": 0 }, "Attribute": { "type": "string", "enum": [ "DEFAULT", "ALL", "AGE_RANGE", "BEARD", "EMOTIONS", "EYE_DIRECTION", "EYEGLASSES", "EYES_OPEN", "GENDER", "MOUTH_OPEN", "MUSTACHE", "FACE_OCCLUDED", "SMILE", "SUNGLASSES" ] }, "Attributes": { "type": "list", "member": { "shape": "Attribute" } }, "AudioMetadata": { "type": "structure", "members": { "Codec": { "shape": "String", "documentation": "The audio codec used to encode or decode the audio stream.
" }, "DurationMillis": { "shape": "ULong", "documentation": "The duration of the audio stream in milliseconds.
" }, "SampleRate": { "shape": "ULong", "documentation": "The sample rate for the audio stream.
" }, "NumberOfChannels": { "shape": "ULong", "documentation": "The number of audio channels in the segment.
" } }, "documentation": "Metadata information about an audio stream. An array of AudioMetadata objects for the audio streams found in a stored video is returned by GetSegmentDetection.
The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.
" }, "S3Object": { "shape": "S3Object" }, "BoundingBox": { "shape": "BoundingBox" } }, "documentation": "An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.
" }, "AuditImages": { "type": "list", "member": { "shape": "AuditImage" } }, "AuditImagesLimit": { "type": "integer", "max": 4, "min": 0 }, "Beard": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the face has beard or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the face has a beard, and the confidence level in the determination.
" }, "BlackFrame": { "type": "structure", "members": { "MaxPixelThreshold": { "shape": "MaxPixelThreshold", "documentation": "A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video, luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.
For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.
The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video. You can lower this threshold to be more strict on black levels.
" }, "MinCoveragePercentage": { "shape": "MinCoveragePercentage", "documentation": "The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered a black frame. Luminance is calculated using the BT.709 matrix.
The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold set. You can reduce this value to allow more noise on the black frame.
A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats, and time periods, they may contain different standards and varying noise levels for black frames that need to be accounted for. For more information, see StartSegmentDetection.
" }, "BodyPart": { "type": "string", "enum": [ "FACE", "HEAD", "LEFT_HAND", "RIGHT_HAND" ] }, "BodyParts": { "type": "list", "member": { "shape": "ProtectiveEquipmentBodyPart" } }, "Boolean": { "type": "boolean" }, "BoundingBox": { "type": "structure", "members": { "Width": { "shape": "Float", "documentation": "Width of the bounding box as a ratio of the overall image width.
" }, "Height": { "shape": "Float", "documentation": "Height of the bounding box as a ratio of the overall image height.
" }, "Left": { "shape": "Float", "documentation": "Left coordinate of the bounding box as a ratio of overall image width.
" }, "Top": { "shape": "Float", "documentation": "Top coordinate of the bounding box as a ratio of overall image height.
" } }, "documentation": "Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).
The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
" }, "Name": { "shape": "String", "documentation": "The name of the celebrity.
" }, "Id": { "shape": "RekognitionUniqueId", "documentation": "A unique identifier for the celebrity.
" }, "Face": { "shape": "ComparedFace", "documentation": "Provides information about the celebrity's face, such as its location on the image.
" }, "MatchConfidence": { "shape": "Percent", "documentation": "The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
" }, "KnownGender": { "shape": "KnownGender" } }, "documentation": "Provides information about a celebrity recognized by the RecognizeCelebrities operation.
" }, "CelebrityDetail": { "type": "structure", "members": { "Urls": { "shape": "Urls", "documentation": "An array of URLs pointing to additional celebrity information.
" }, "Name": { "shape": "String", "documentation": "The name of the celebrity.
" }, "Id": { "shape": "RekognitionUniqueId", "documentation": "The unique identifier for the celebrity.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
" }, "BoundingBox": { "shape": "BoundingBox", "documentation": "Bounding box around the body of a celebrity.
" }, "Face": { "shape": "FaceDetail", "documentation": "Face details for the recognized celebrity.
" }, "KnownGender": { "shape": "KnownGender", "documentation": "Retrieves the known gender for the celebrity.
" } }, "documentation": "Information about a recognized celebrity.
" }, "CelebrityList": { "type": "list", "member": { "shape": "Celebrity" } }, "CelebrityRecognition": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The time, in milliseconds from the start of the video, that the celebrity was recognized. Note that Timestamp is not guaranteed to be accurate to the individual frame where the celebrity first appears.
Information about a recognized celebrity.
" } }, "documentation": "Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.
" }, "CelebrityRecognitionSortBy": { "type": "string", "enum": [ "ID", "TIMESTAMP" ] }, "CelebrityRecognitions": { "type": "list", "member": { "shape": "CelebrityRecognition" } }, "ClientRequestToken": { "type": "string", "max": 64, "min": 1, "pattern": "^[a-zA-Z0-9-_]+$" }, "CollectionId": { "type": "string", "max": 255, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "CollectionIdList": { "type": "list", "member": { "shape": "CollectionId" } }, "CompareFacesMatch": { "type": "structure", "members": { "Similarity": { "shape": "Percent", "documentation": "Level of confidence that the faces match.
" }, "Face": { "shape": "ComparedFace", "documentation": "Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
" } }, "documentation": "Provides information about a face in a target image that matches the source image face analyzed by CompareFaces. The Face property contains the bounding box of the face in the target image. The Similarity property is the confidence that the source image face matches the face in the bounding box.
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.
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.
The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" } } }, "CompareFacesResponse": { "type": "structure", "members": { "SourceImageFace": { "shape": "ComparedSourceImageFace", "documentation": "The face in the source image that was used for comparison.
" }, "FaceMatches": { "shape": "CompareFacesMatchList", "documentation": "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.
An array of faces in the target image that did not match the source image face.
" }, "SourceImageOrientationCorrection": { "shape": "OrientationCorrection", "documentation": "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.
" }, "TargetImageOrientationCorrection": { "shape": "OrientationCorrection", "documentation": "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.
" } } }, "CompareFacesUnmatchList": { "type": "list", "member": { "shape": "ComparedFace" } }, "ComparedFace": { "type": "structure", "members": { "BoundingBox": { "shape": "BoundingBox", "documentation": "Bounding box of the face.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence that what the bounding box contains is a face.
" }, "Landmarks": { "shape": "Landmarks", "documentation": "An array of facial landmarks.
" }, "Pose": { "shape": "Pose", "documentation": "Indicates the pose of the face as determined by its pitch, roll, and yaw.
" }, "Quality": { "shape": "ImageQuality", "documentation": "Identifies face image brightness and sharpness.
" }, "Emotions": { "shape": "Emotions", "documentation": "The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include \"Happy\", \"Sad\", \"Angry\", \"Confused\", \"Disgusted\", \"Surprised\", \"Calm\", \"Unknown\", and \"Fear\".
" }, "Smile": { "shape": "Smile", "documentation": "Indicates whether or not the face is smiling, and the confidence level in the determination.
" } }, "documentation": "Provides face metadata for target image faces that are analyzed by CompareFaces and RecognizeCelebrities.
Bounding box of the face.
" }, "Confidence": { "shape": "Percent", "documentation": "Confidence level that the selected bounding box contains a face.
" } }, "documentation": "Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.
" }, "ConnectedHomeLabel": { "type": "string" }, "ConnectedHomeLabels": { "type": "list", "member": { "shape": "ConnectedHomeLabel" }, "max": 128, "min": 1 }, "ConnectedHomeSettings": { "type": "structure", "required": [ "Labels" ], "members": { "Labels": { "shape": "ConnectedHomeLabels", "documentation": "Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".
" }, "MinConfidence": { "shape": "Percent", "documentation": "The minimum confidence required to label an object in the video.
" } }, "documentation": " Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.
Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".
" }, "MinConfidence": { "shape": "Percent", "documentation": "The minimum confidence required to label an object in the video.
" } }, "documentation": "The label detection settings you want to use in your stream processor. This includes the labels you want the stream processor to detect and the minimum confidence level allowed to label objects.
" }, "ContentClassifier": { "type": "string", "enum": [ "FreeOfPersonallyIdentifiableInformation", "FreeOfAdultContent" ] }, "ContentClassifiers": { "type": "list", "member": { "shape": "ContentClassifier" }, "max": 256 }, "ContentModerationAggregateBy": { "type": "string", "enum": [ "TIMESTAMPS", "SEGMENTS" ] }, "ContentModerationDetection": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "Time, in milliseconds from the beginning of the video, that the content moderation label was detected. Note that Timestamp is not guaranteed to be accurate to the individual frame where the moderated content first appears.
The content moderation label detected by in the stored video.
" }, "StartTimestampMillis": { "shape": "ULong", "documentation": "The time in milliseconds defining the start of the timeline segment containing a continuously detected moderation label.
" }, "EndTimestampMillis": { "shape": "ULong", "documentation": "The time in milliseconds defining the end of the timeline segment containing a continuously detected moderation label.
" }, "DurationMillis": { "shape": "ULong", "documentation": "The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.
" }, "ContentTypes": { "shape": "ContentTypes", "documentation": "A list of predicted results for the type of content an image contains. For example, the image content might be from animation, sports, or a video game.
" } }, "documentation": "Information about an inappropriate, unwanted, or offensive content label detection in a stored video.
" }, "ContentModerationDetections": { "type": "list", "member": { "shape": "ContentModerationDetection" } }, "ContentModerationSortBy": { "type": "string", "enum": [ "NAME", "TIMESTAMP" ] }, "ContentType": { "type": "structure", "members": { "Confidence": { "shape": "Percent", "documentation": "The confidence level of the label given
" }, "Name": { "shape": "String", "documentation": "The name of the label
" } }, "documentation": "Contains information regarding the confidence and name of a detected content type.
" }, "ContentTypes": { "type": "list", "member": { "shape": "ContentType" }, "max": 50, "min": 0 }, "CopyProjectVersionRequest": { "type": "structure", "required": [ "SourceProjectArn", "SourceProjectVersionArn", "DestinationProjectArn", "VersionName", "OutputConfig" ], "members": { "SourceProjectArn": { "shape": "ProjectArn", "documentation": "The ARN of the source project in the trusting AWS account.
" }, "SourceProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "The ARN of the model version in the source project that you want to copy to a destination project.
" }, "DestinationProjectArn": { "shape": "ProjectArn", "documentation": "The ARN of the project in the trusted AWS account that you want to copy the model version to.
" }, "VersionName": { "shape": "VersionName", "documentation": "A name for the version of the model that's copied to the destination project.
" }, "OutputConfig": { "shape": "OutputConfig", "documentation": "The S3 bucket and folder location where the training output for the source model version is placed.
" }, "Tags": { "shape": "TagMap", "documentation": "The key-value tags to assign to the model version.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
kms:CreateGrant
kms:DescribeKey
kms:GenerateDataKey
kms:Decrypt
If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.
The ARN of the copied model version in the destination project.
" } } }, "CoversBodyPart": { "type": "structure", "members": { "Confidence": { "shape": "Percent", "documentation": "The confidence that Amazon Rekognition has in the value of Value.
True if the PPE covers the corresponding body part, otherwise false.
" } }, "documentation": "Information about an item of Personal Protective Equipment covering a corresponding body part. For more information, see DetectProtectiveEquipment.
" }, "CreateCollectionRequest": { "type": "structure", "required": [ "CollectionId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "ID for the collection that you are creating.
" }, "Tags": { "shape": "TagMap", "documentation": "A set of tags (key-value pairs) that you want to attach to the collection.
" } } }, "CreateCollectionResponse": { "type": "structure", "members": { "StatusCode": { "shape": "UInteger", "documentation": "HTTP status code indicating the result of the operation.
" }, "CollectionArn": { "shape": "String", "documentation": "Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the collection you are creating.
" } } }, "CreateDatasetRequest": { "type": "structure", "required": [ "DatasetType", "ProjectArn" ], "members": { "DatasetSource": { "shape": "DatasetSource", "documentation": " The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify datasetSource, an empty dataset is created. To add labeled images to the dataset, You can use the console or call UpdateDatasetEntries.
The type of the dataset. Specify TRAIN to create a training dataset. Specify TEST to create a test dataset.
The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.
" }, "Tags": { "shape": "TagMap", "documentation": "A set of tags (key-value pairs) that you want to attach to the dataset.
" } } }, "CreateDatasetResponse": { "type": "structure", "members": { "DatasetArn": { "shape": "DatasetArn", "documentation": "The ARN of the created Amazon Rekognition Custom Labels dataset.
" } } }, "CreateFaceLivenessSessionRequest": { "type": "structure", "members": { "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.
" }, "Settings": { "shape": "CreateFaceLivenessSessionRequestSettings", "documentation": "A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.
Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple CreateFaceLivenessSession requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system. Requires that the caller has the s3:PutObject permission on the Amazon S3 bucket.
Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.
" } }, "documentation": "A session settings object. It contains settings for the operation to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.
" }, "CreateFaceLivenessSessionResponse": { "type": "structure", "required": [ "SessionId" ], "members": { "SessionId": { "shape": "LivenessSessionId", "documentation": "A unique 128-bit UUID identifying a Face Liveness session. A new sessionID must be used for every Face Liveness check. If a given sessionID is used for subsequent Face Liveness checks, the checks will fail. Additionally, a SessionId expires 3 minutes after it's sent, making all Liveness data associated with the session (e.g., sessionID, reference image, audit images, etc.) unavailable.
" } } }, "CreateProjectRequest": { "type": "structure", "required": [ "ProjectName" ], "members": { "ProjectName": { "shape": "ProjectName", "documentation": "The name of the project to create.
" }, "Feature": { "shape": "CustomizationFeature", "documentation": "Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.
" }, "AutoUpdate": { "shape": "ProjectAutoUpdate", "documentation": "Specifies whether automatic retraining should be attempted for the versions of the project. Automatic retraining is done as a best effort. Required argument for Content Moderation. Applicable only to adapters.
" }, "Tags": { "shape": "TagMap", "documentation": "A set of tags (key-value pairs) that you want to attach to the project.
" } } }, "CreateProjectResponse": { "type": "structure", "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.
" } } }, "CreateProjectVersionRequest": { "type": "structure", "required": [ "ProjectArn", "VersionName", "OutputConfig" ], "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The ARN of the Amazon Rekognition project that will manage the project version you want to train.
" }, "VersionName": { "shape": "VersionName", "documentation": "A name for the version of the project version. This value must be unique.
" }, "OutputConfig": { "shape": "OutputConfig", "documentation": "The Amazon S3 bucket location to store the results of training. The bucket can be any S3 bucket in your AWS account. You need s3:PutObject permission on the bucket.
Specifies an external manifest that the services uses to train the project version. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.
Specifies an external manifest that the service uses to test the project version. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.
A set of tags (key-value pairs) that you want to attach to the project version.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied into the service for the project version. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).
If you choose to use your own KMS key, you need the following permissions on the KMS key.
kms:CreateGrant
kms:DescribeKey
kms:GenerateDataKey
kms:Decrypt
If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.
A description applied to the project version being created.
" }, "FeatureConfig": { "shape": "CustomizationFeatureConfig", "documentation": "Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.
" } } }, "CreateProjectVersionResponse": { "type": "structure", "members": { "ProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "The ARN of the model or the project version that was created. Use DescribeProjectVersion to get the current status of the training operation.
Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.
Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.
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. This is required for both face search and label detection stream processors.
Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.
The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.
" }, "Tags": { "shape": "TagMap", "documentation": "A set of tags (key-value pairs) that you want to attach to the stream processor.
" }, "NotificationChannel": { "shape": "StreamProcessorNotificationChannel" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.
" }, "RegionsOfInterest": { "shape": "RegionsOfInterest", "documentation": "
Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
" }, "DataSharingPreference": { "shape": "StreamProcessorDataSharingPreference", "documentation": "Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.
" } } }, "CreateStreamProcessorResponse": { "type": "structure", "members": { "StreamProcessorArn": { "shape": "StreamProcessorArn", "documentation": "Amazon Resource Number for the newly created stream processor.
" } } }, "CreateUserRequest": { "type": "structure", "required": [ "CollectionId", "UserId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection to which the new UserID needs to be created.
" }, "UserId": { "shape": "UserId", "documentation": "ID for the UserID to be created. This ID needs to be unique within the collection.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "Idempotent token used to identify the request to CreateUser. If you use the same token with multiple CreateUser requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
The name of the custom label.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.
" }, "Geometry": { "shape": "Geometry", "documentation": "The location of the detected object on the image that corresponds to the custom label. Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon for more accurate spatial information.
" } }, "documentation": "A custom label detected in an image by a call to DetectCustomLabels.
" }, "CustomLabels": { "type": "list", "member": { "shape": "CustomLabel" } }, "CustomizationFeature": { "type": "string", "enum": [ "CONTENT_MODERATION", "CUSTOM_LABELS" ] }, "CustomizationFeatureConfig": { "type": "structure", "members": { "ContentModeration": { "shape": "CustomizationFeatureContentModerationConfig", "documentation": "Configuration options for Custom Moderation training.
" } }, "documentation": "Feature specific configuration for the training job. Configuration provided for the job must match the feature type parameter associated with project. If configuration and feature type do not match an InvalidParameterException is returned.
" }, "CustomizationFeatureContentModerationConfig": { "type": "structure", "members": { "ConfidenceThreshold": { "shape": "Percent", "documentation": "The confidence level you plan to use to identify if unsafe content is present during inference.
" } }, "documentation": "Configuration options for Content Moderation training.
" }, "CustomizationFeatures": { "type": "list", "member": { "shape": "CustomizationFeature" }, "max": 2, "min": 1 }, "DatasetArn": { "type": "string", "max": 2048, "min": 20, "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/dataset\\/(train|test)\\/[0-9]+$)" }, "DatasetChanges": { "type": "structure", "required": [ "GroundTruth" ], "members": { "GroundTruth": { "shape": "GroundTruthBlob", "documentation": "A Base64-encoded binary data object containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling UpdateDatasetEntries. If you are using an AWS SDK to call UpdateDatasetEntries, you don't need to encode Changes as the SDK encodes the data for you.
For example JSON lines, see Image-Level labels in manifest files and and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.
" } }, "documentation": " Describes updates or additions to a dataset. A Single update or addition is an entry (JSON Line) that provides information about a single image. To update an existing entry, you match the source-ref field of the update entry with the source-ref filed of the entry that you want to update. If the source-ref field doesn't match an existing entry, the entry is added to dataset as a new entry.
The Unix timestamp for the time and date that the dataset was created.
" }, "LastUpdatedTimestamp": { "shape": "DateTime", "documentation": "The Unix timestamp for the date and time that the dataset was last updated.
" }, "Status": { "shape": "DatasetStatus", "documentation": "The status of the dataset.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "The status message for the dataset.
" }, "StatusMessageCode": { "shape": "DatasetStatusMessageCode", "documentation": "The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.
" }, "DatasetStats": { "shape": "DatasetStats", "documentation": "The status message code for the dataset.
" } }, "documentation": "A description for a dataset. For more information, see DescribeDataset.
The status fields Status, StatusMessage, and StatusMessageCode reflect the last operation on the dataset.
The name of the label.
" }, "LabelStats": { "shape": "DatasetLabelStats", "documentation": "Statistics about the label.
" } }, "documentation": "Describes a dataset label. For more information, see ListDatasetLabels.
" }, "DatasetLabelDescriptions": { "type": "list", "member": { "shape": "DatasetLabelDescription" } }, "DatasetLabelStats": { "type": "structure", "members": { "EntryCount": { "shape": "UInteger", "documentation": "The total number of images that use the label.
" }, "BoundingBoxCount": { "shape": "UInteger", "documentation": "The total number of images that have the label assigned to a bounding box.
" } }, "documentation": "Statistics about a label used in a dataset. For more information, see DatasetLabelDescription.
" }, "DatasetLabels": { "type": "list", "member": { "shape": "DatasetLabel" }, "max": 10, "min": 1 }, "DatasetMetadata": { "type": "structure", "members": { "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix timestamp for the date and time that the dataset was created.
" }, "DatasetType": { "shape": "DatasetType", "documentation": "The type of the dataset.
" }, "DatasetArn": { "shape": "DatasetArn", "documentation": "The Amazon Resource Name (ARN) for the dataset.
" }, "Status": { "shape": "DatasetStatus", "documentation": "The status for the dataset.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "The status message for the dataset.
" }, "StatusMessageCode": { "shape": "DatasetStatusMessageCode", "documentation": "The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.
" } }, "documentation": "Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see ProjectDescription.
" }, "DatasetMetadataList": { "type": "list", "member": { "shape": "DatasetMetadata" } }, "DatasetSource": { "type": "structure", "members": { "GroundTruthManifest": { "shape": "GroundTruthManifest" }, "DatasetArn": { "shape": "DatasetArn", "documentation": "The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.
" } }, "documentation": " The source that Amazon Rekognition Custom Labels uses to create a dataset. To use an Amazon Sagemaker format manifest file, specify the S3 bucket location in the GroundTruthManifest field. The S3 bucket must be in your AWS account. To create a copy of an existing dataset, specify the Amazon Resource Name (ARN) of an existing dataset in DatasetArn.
You need to specify a value for DatasetArn or GroundTruthManifest, but not both. if you supply both values, or if you don't specify any values, an InvalidParameterException exception occurs.
For more information, see CreateDataset.
" }, "DatasetStats": { "type": "structure", "members": { "LabeledEntries": { "shape": "UInteger", "documentation": "The total number of images in the dataset that have labels.
" }, "TotalEntries": { "shape": "UInteger", "documentation": "The total number of images in the dataset.
" }, "TotalLabels": { "shape": "UInteger", "documentation": "The total number of labels declared in the dataset.
" }, "ErrorEntries": { "shape": "UInteger", "documentation": "The total number of entries that contain at least one error.
" } }, "documentation": "Provides statistics about a dataset. For more information, see DescribeDataset.
" }, "DatasetStatus": { "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED", "DELETE_IN_PROGRESS" ] }, "DatasetStatusMessageCode": { "type": "string", "enum": [ "SUCCESS", "SERVICE_ERROR", "CLIENT_ERROR" ] }, "DatasetType": { "type": "string", "enum": [ "TRAIN", "TEST" ] }, "DateTime": { "type": "timestamp" }, "Degree": { "type": "float", "max": 180, "min": -180 }, "DeleteCollectionRequest": { "type": "structure", "required": [ "CollectionId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "ID of the collection to delete.
" } } }, "DeleteCollectionResponse": { "type": "structure", "members": { "StatusCode": { "shape": "UInteger", "documentation": "HTTP status code that indicates the result of the operation.
" } } }, "DeleteDatasetRequest": { "type": "structure", "required": [ "DatasetArn" ], "members": { "DatasetArn": { "shape": "DatasetArn", "documentation": "The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.
" } } }, "DeleteDatasetResponse": { "type": "structure", "members": {} }, "DeleteFacesRequest": { "type": "structure", "required": [ "CollectionId", "FaceIds" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "Collection from which to remove the specific faces.
" }, "FaceIds": { "shape": "FaceIdList", "documentation": "An array of face IDs to delete.
" } } }, "DeleteFacesResponse": { "type": "structure", "members": { "DeletedFaces": { "shape": "FaceIdList", "documentation": "An array of strings (face IDs) of the faces that were deleted.
" }, "UnsuccessfulFaceDeletions": { "shape": "UnsuccessfulFaceDeletionsList", "documentation": "An array of any faces that weren't deleted.
" } } }, "DeleteProjectPolicyRequest": { "type": "structure", "required": [ "ProjectArn", "PolicyName" ], "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.
" }, "PolicyName": { "shape": "ProjectPolicyName", "documentation": "The name of the policy that you want to delete.
" }, "PolicyRevisionId": { "shape": "ProjectPolicyRevisionId", "documentation": "The ID of the project policy revision that you want to delete.
" } } }, "DeleteProjectPolicyResponse": { "type": "structure", "members": {} }, "DeleteProjectRequest": { "type": "structure", "required": [ "ProjectArn" ], "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the project that you want to delete.
" } } }, "DeleteProjectResponse": { "type": "structure", "members": { "Status": { "shape": "ProjectStatus", "documentation": "The current status of the delete project operation.
" } } }, "DeleteProjectVersionRequest": { "type": "structure", "required": [ "ProjectVersionArn" ], "members": { "ProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "The Amazon Resource Name (ARN) of the project version that you want to delete.
" } } }, "DeleteProjectVersionResponse": { "type": "structure", "members": { "Status": { "shape": "ProjectVersionStatus", "documentation": "The status of the deletion operation.
" } } }, "DeleteStreamProcessorRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "StreamProcessorName", "documentation": "The name of the stream processor you want to delete.
" } } }, "DeleteStreamProcessorResponse": { "type": "structure", "members": {} }, "DeleteUserRequest": { "type": "structure", "required": [ "CollectionId", "UserId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection from which the UserID needs to be deleted.
" }, "UserId": { "shape": "UserId", "documentation": "ID for the UserID to be deleted.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "Idempotent token used to identify the request to DeleteUser. If you use the same token with multiple DeleteUser requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
The ID of the collection to describe.
" } } }, "DescribeCollectionResponse": { "type": "structure", "members": { "FaceCount": { "shape": "ULong", "documentation": "The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
" }, "FaceModelVersion": { "shape": "String", "documentation": "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.
" }, "CollectionARN": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the collection.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "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.
" }, "UserCount": { "shape": "ULong", "documentation": "The number of UserIDs assigned to the specified colleciton.
" } } }, "DescribeDatasetRequest": { "type": "structure", "required": [ "DatasetArn" ], "members": { "DatasetArn": { "shape": "DatasetArn", "documentation": "The Amazon Resource Name (ARN) of the dataset that you want to describe.
" } } }, "DescribeDatasetResponse": { "type": "structure", "members": { "DatasetDescription": { "shape": "DatasetDescription", "documentation": "The description for the dataset.
" } } }, "DescribeProjectVersionsRequest": { "type": "structure", "required": [ "ProjectArn" ], "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe.
" }, "VersionNames": { "shape": "VersionNames", "documentation": "A list of model or project version names that you want to describe. You can add up to 10 model or project version names to the list. If you don't specify a value, all project version descriptions are returned. A version name is part of a project version ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN. arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" }, "MaxResults": { "shape": "ProjectVersionsPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
" } } }, "DescribeProjectVersionsResponse": { "type": "structure", "members": { "ProjectVersionDescriptions": { "shape": "ProjectVersionDescriptions", "documentation": "A list of project version descriptions. The list is sorted by the creation date and time of the project versions, latest to earliest.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" } } }, "DescribeProjectsRequest": { "type": "structure", "members": { "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" }, "MaxResults": { "shape": "ProjectsPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
" }, "ProjectNames": { "shape": "ProjectNames", "documentation": "A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.
" }, "Features": { "shape": "CustomizationFeatures", "documentation": "Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.
" } } }, "DescribeProjectsResponse": { "type": "structure", "members": { "ProjectDescriptions": { "shape": "ProjectDescriptions", "documentation": "A list of project descriptions. The list is sorted by the date and time the projects are created.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" } } }, "DescribeStreamProcessorRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "StreamProcessorName", "documentation": "Name of the stream processor for which you want information.
" } } }, "DescribeStreamProcessorResponse": { "type": "structure", "members": { "Name": { "shape": "StreamProcessorName", "documentation": "Name of the stream processor.
" }, "StreamProcessorArn": { "shape": "StreamProcessorArn", "documentation": "ARN of the stream processor.
" }, "Status": { "shape": "StreamProcessorStatus", "documentation": "Current status of the stream processor.
" }, "StatusMessage": { "shape": "String", "documentation": "Detailed status message about the stream processor.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "Date and time the stream processor was created
" }, "LastUpdateTimestamp": { "shape": "DateTime", "documentation": "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.
" }, "Input": { "shape": "StreamProcessorInput", "documentation": "Kinesis video stream that provides the source streaming video.
" }, "Output": { "shape": "StreamProcessorOutput", "documentation": "Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
" }, "RoleArn": { "shape": "RoleArn", "documentation": "ARN of the IAM role that allows access to the stream processor.
" }, "Settings": { "shape": "StreamProcessorSettings", "documentation": "Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.
The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.
" }, "RegionsOfInterest": { "shape": "RegionsOfInterest", "documentation": "Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
" }, "DataSharingPreference": { "shape": "StreamProcessorDataSharingPreference", "documentation": "Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.
" } } }, "DetectCustomLabelsRequest": { "type": "structure", "required": [ "ProjectVersionArn", "Image" ], "members": { "ProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "The ARN of the model version that you want to use. Only models associated with Custom Labels projects accepted by the operation. If a provided ARN refers to a model version associated with a project for a different feature type, then an InvalidParameterException is returned.
" }, "Image": { "shape": "Image" }, "MaxResults": { "shape": "UInteger", "documentation": "Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.
" }, "MinConfidence": { "shape": "Percent", "documentation": "Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.
An array of custom labels detected in the input image.
" } } }, "DetectFacesRequest": { "type": "structure", "required": [ "Image" ], "members": { "Image": { "shape": "Image", "documentation": "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.
An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\", \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all facial attributes by using [\"ALL\"]. Requesting more attributes may increase response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical \"AND\" operator to determine which attributes to return (in this case, all attributes).
Note that while the FaceOccluded and EyeDirection attributes are supported when using DetectFaces, they aren't supported when analyzing videos with StartFaceDetection and GetFaceDetection.
Details of each face found in the image.
" }, "OrientationCorrection": { "shape": "OrientationCorrection", "documentation": "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.
" } } }, "DetectLabelsFeatureList": { "type": "list", "member": { "shape": "DetectLabelsFeatureName" }, "max": 2, "min": 0 }, "DetectLabelsFeatureName": { "type": "string", "enum": [ "GENERAL_LABELS", "IMAGE_PROPERTIES" ] }, "DetectLabelsImageBackground": { "type": "structure", "members": { "Quality": { "shape": "DetectLabelsImageQuality", "documentation": "The quality of the image background as defined by brightness and sharpness.
" }, "DominantColors": { "shape": "DominantColors", "documentation": "The dominant colors found in the background of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).
" } }, "documentation": "The background of the image with regard to image quality and dominant colors.
" }, "DetectLabelsImageForeground": { "type": "structure", "members": { "Quality": { "shape": "DetectLabelsImageQuality", "documentation": "The quality of the image foreground as defined by brightness and sharpness.
" }, "DominantColors": { "shape": "DominantColors", "documentation": "The dominant colors found in the foreground of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).
" } }, "documentation": "The foreground of the image with regard to image quality and dominant colors.
" }, "DetectLabelsImageProperties": { "type": "structure", "members": { "Quality": { "shape": "DetectLabelsImageQuality", "documentation": "Information about the quality of the image foreground as defined by brightness, sharpness, and contrast. The higher the value the greater the brightness, sharpness, and contrast respectively.
" }, "DominantColors": { "shape": "DominantColors", "documentation": "Information about the dominant colors found in an image, described with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).
" }, "Foreground": { "shape": "DetectLabelsImageForeground", "documentation": "Information about the properties of an image’s foreground, including the foreground’s quality and dominant colors, including the quality and dominant colors of the image.
" }, "Background": { "shape": "DetectLabelsImageBackground", "documentation": "Information about the properties of an image’s background, including the background’s quality and dominant colors, including the quality and dominant colors of the image.
" } }, "documentation": "Information about the quality and dominant colors of an input image. Quality and color information is returned for the entire image, foreground, and background.
" }, "DetectLabelsImagePropertiesSettings": { "type": "structure", "members": { "MaxDominantColors": { "shape": "DetectLabelsMaxDominantColors", "documentation": "The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.
" } }, "documentation": "Settings for the IMAGE_PROPERTIES feature type.
" }, "DetectLabelsImageQuality": { "type": "structure", "members": { "Brightness": { "shape": "Float", "documentation": "The brightness of an image provided for label detection.
" }, "Sharpness": { "shape": "Float", "documentation": "The sharpness of an image provided for label detection.
" }, "Contrast": { "shape": "Float", "documentation": "The contrast of an image provided for label detection.
" } }, "documentation": "The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.
" }, "DetectLabelsMaxDominantColors": { "type": "integer", "max": 20, "min": 0 }, "DetectLabelsRequest": { "type": "structure", "required": [ "Image" ], "members": { "Image": { "shape": "Image", "documentation": "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.
Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.
" }, "MinConfidence": { "shape": "Percent", "documentation": "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. Only valid when GENERAL_LABELS is specified as a feature type in the Feature input parameter.
A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality. If no option is specified GENERAL_LABELS is used by default.
" }, "Settings": { "shape": "DetectLabelsSettings", "documentation": "A list of the filters to be applied to returned detected labels and image properties. Specified filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual labels or label categories. The exact label names or label categories must be supplied. For a full list of labels and label categories, see Detecting labels.
" } } }, "DetectLabelsResponse": { "type": "structure", "members": { "Labels": { "shape": "Labels", "documentation": "An array of labels for the real-world objects detected.
" }, "OrientationCorrection": { "shape": "OrientationCorrection", "documentation": "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.
" }, "LabelModelVersion": { "shape": "String", "documentation": "Version number of the label detection model that was used to detect labels.
" }, "ImageProperties": { "shape": "DetectLabelsImageProperties", "documentation": "Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.
" } } }, "DetectLabelsSettings": { "type": "structure", "members": { "GeneralLabels": { "shape": "GeneralLabelsSettings", "documentation": "Contains the specified filters for GENERAL_LABELS.
" }, "ImageProperties": { "shape": "DetectLabelsImagePropertiesSettings", "documentation": "Contains the chosen number of maximum dominant colors in an image.
" } }, "documentation": "Settings for the DetectLabels request. Settings can include filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters allow specification of a maximum number of dominant colors.
" }, "DetectModerationLabelsRequest": { "type": "structure", "required": [ "Image" ], "members": { "Image": { "shape": "Image", "documentation": "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.
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.
Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.
" }, "ProjectVersion": { "shape": "ProjectVersionId", "documentation": "Identifier for the custom adapter. Expects the ProjectVersionArn as a value. Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.
" } } }, "DetectModerationLabelsResponse": { "type": "structure", "members": { "ModerationLabels": { "shape": "ModerationLabels", "documentation": "Array of detected Moderation labels. For video operations, this includes the time, in milliseconds from the start of the video, they were detected.
" }, "ModerationModelVersion": { "shape": "String", "documentation": "Version number of the base moderation detection model that was used to detect unsafe content.
" }, "HumanLoopActivationOutput": { "shape": "HumanLoopActivationOutput", "documentation": "Shows the results of the human in the loop evaluation.
" }, "ProjectVersion": { "shape": "ProjectVersionId", "documentation": "Identifier of the custom adapter that was used during inference. If during inference the adapter was EXPIRED, then the parameter will not be returned, indicating that a base moderation detection project version was used.
" }, "ContentTypes": { "shape": "ContentTypes", "documentation": "A list of predicted results for the type of content an image contains. For example, the image content might be from animation, sports, or a video game.
" } } }, "DetectProtectiveEquipmentRequest": { "type": "structure", "required": [ "Image" ], "members": { "Image": { "shape": "Image", "documentation": "The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.
" }, "SummarizationAttributes": { "shape": "ProtectiveEquipmentSummarizationAttributes", "documentation": "An array of PPE types that you want to summarize.
" } } }, "DetectProtectiveEquipmentResponse": { "type": "structure", "members": { "ProtectiveEquipmentModelVersion": { "shape": "String", "documentation": "The version number of the PPE detection model used to detect PPE in the image.
" }, "Persons": { "shape": "ProtectiveEquipmentPersons", "documentation": "An array of persons detected in the image (including persons not wearing PPE).
" }, "Summary": { "shape": "ProtectiveEquipmentSummary", "documentation": "Summary information for the types of PPE specified in the SummarizationAttributes input parameter.
A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the image.
A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response. WordFilter looks at a word’s height, width, and minimum confidence. RegionOfInterest lets you set a specific region of the image to look for text in.
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.
Optional parameters that let you set the criteria that the text must meet to be included in your response.
" } } }, "DetectTextResponse": { "type": "structure", "members": { "TextDetections": { "shape": "TextDetectionList", "documentation": "An array of text that was detected in the input image.
" }, "TextModelVersion": { "shape": "String", "documentation": "The model version used to detect text.
" } } }, "DetectionFilter": { "type": "structure", "members": { "MinConfidence": { "shape": "Percent", "documentation": "Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.
" }, "MinBoundingBoxHeight": { "shape": "BoundingBoxHeight", "documentation": "Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.
" }, "MinBoundingBoxWidth": { "shape": "BoundingBoxWidth", "documentation": "Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.
" } }, "documentation": "A set of parameters that allow you to filter out certain results from your returned results.
" }, "DisassociateFacesRequest": { "type": "structure", "required": [ "CollectionId", "UserId", "FaceIds" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection containing the UserID.
" }, "UserId": { "shape": "UserId", "documentation": "ID for the existing UserID.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "Idempotent token used to identify the request to DisassociateFaces. If you use the same token with multiple DisassociateFaces requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
An array of face IDs to disassociate from the UserID.
" } } }, "DisassociateFacesResponse": { "type": "structure", "members": { "DisassociatedFaces": { "shape": "DisassociatedFacesList", "documentation": "An array of DissociatedFace objects containing FaceIds that are successfully disassociated with the UserID is returned. Returned if the DisassociatedFaces action is successful.
" }, "UnsuccessfulFaceDisassociations": { "shape": "UnsuccessfulFaceDisassociationList", "documentation": "An array of UnsuccessfulDisassociation objects containing FaceIds that are not successfully associated, along with the reasons for the failure to associate. Returned if the DisassociateFaces action is successful.
" }, "UserStatus": { "shape": "UserStatus", "documentation": "The status of an update made to a User. Reflects if the User has been updated for every requested change.
" } } }, "DisassociatedFace": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "Unique identifier assigned to the face.
" } }, "documentation": "Provides face metadata for the faces that are disassociated from a specific UserID.
" }, "DisassociatedFacesList": { "type": "list", "member": { "shape": "DisassociatedFace" }, "max": 100, "min": 0 }, "DistributeDataset": { "type": "structure", "required": [ "Arn" ], "members": { "Arn": { "shape": "DatasetArn", "documentation": "The Amazon Resource Name (ARN) of the dataset that you want to use.
" } }, "documentation": "A training dataset or a test dataset used in a dataset distribution operation. For more information, see DistributeDatasetEntries.
" }, "DistributeDatasetEntriesRequest": { "type": "structure", "required": [ "Datasets" ], "members": { "Datasets": { "shape": "DistributeDatasetMetadataList", "documentation": "The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to the same project. The test dataset must be empty.
" } } }, "DistributeDatasetEntriesResponse": { "type": "structure", "members": {} }, "DistributeDatasetMetadataList": { "type": "list", "member": { "shape": "DistributeDataset" }, "max": 2, "min": 2 }, "DominantColor": { "type": "structure", "members": { "Red": { "shape": "UInteger", "documentation": "The Red RGB value for a dominant color.
" }, "Blue": { "shape": "UInteger", "documentation": "The Blue RGB value for a dominant color.
" }, "Green": { "shape": "UInteger", "documentation": "The Green RGB value for a dominant color.
" }, "HexCode": { "shape": "String", "documentation": "The Hex code equivalent of the RGB values for a dominant color.
" }, "CSSColor": { "shape": "String", "documentation": "The CSS color name of a dominant color.
" }, "SimplifiedColor": { "shape": "String", "documentation": "One of 12 simplified color names applied to a dominant color.
" }, "PixelPercent": { "shape": "Percent", "documentation": "The percentage of image pixels that have a given dominant color.
" } }, "documentation": "A description of the dominant colors in an image.
" }, "DominantColors": { "type": "list", "member": { "shape": "DominantColor" } }, "Emotion": { "type": "structure", "members": { "Type": { "shape": "EmotionName", "documentation": "Type of emotion detected.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "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.
" }, "EmotionName": { "type": "string", "enum": [ "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN", "FEAR" ] }, "Emotions": { "type": "list", "member": { "shape": "Emotion" } }, "EquipmentDetection": { "type": "structure", "members": { "BoundingBox": { "shape": "BoundingBox", "documentation": "A bounding box surrounding the item of detected PPE.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of PPE.
The type of detected PPE.
" }, "CoversBodyPart": { "shape": "CoversBodyPart", "documentation": "Information about the body part covered by the detected PPE.
" } }, "documentation": "Information about an item of Personal Protective Equipment (PPE) detected by DetectProtectiveEquipment. For more information, see DetectProtectiveEquipment.
" }, "EquipmentDetections": { "type": "list", "member": { "shape": "EquipmentDetection" } }, "EvaluationResult": { "type": "structure", "members": { "F1Score": { "shape": "Float", "documentation": "The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.
" }, "Summary": { "shape": "Summary", "documentation": "The S3 bucket that contains the training summary.
" } }, "documentation": "The evaluation results for the training of a model.
" }, "ExtendedPaginationToken": { "type": "string", "max": 1024 }, "ExternalImageId": { "type": "string", "max": 255, "min": 1, "pattern": "[a-zA-Z0-9_.\\-:]+" }, "EyeDirection": { "type": "structure", "members": { "Yaw": { "shape": "Degree", "documentation": "Value representing eye direction on the yaw axis.
" }, "Pitch": { "shape": "Degree", "documentation": "Value representing eye direction on the pitch axis.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that the service has in its predicted eye direction.
" } }, "documentation": "Indicates the direction the eyes are gazing in (independent of the head pose) as determined by its pitch and yaw.
" }, "EyeOpen": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the eyes on the face are open.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
" }, "Eyeglasses": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the face is wearing eye glasses or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
" }, "Face": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "Unique identifier that Amazon Rekognition assigns to the face.
" }, "BoundingBox": { "shape": "BoundingBox", "documentation": "Bounding box of the face.
" }, "ImageId": { "shape": "ImageId", "documentation": "Unique identifier that Amazon Rekognition assigns to the input image.
" }, "ExternalImageId": { "shape": "ExternalImageId", "documentation": "Identifier that you assign to all the faces in the input image.
" }, "Confidence": { "shape": "Percent", "documentation": "Confidence level that the bounding box contains a face (and not a different object such as a tree).
" }, "IndexFacesModelVersion": { "shape": "IndexFacesModelVersion", "documentation": "The version of the face detect and storage model that was used when indexing the face vector.
" }, "UserId": { "shape": "UserId", "documentation": "Unique identifier assigned to the user.
" } }, "documentation": "Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
" }, "FaceAttributes": { "type": "string", "enum": [ "DEFAULT", "ALL" ] }, "FaceDetail": { "type": "structure", "members": { "BoundingBox": { "shape": "BoundingBox", "documentation": "Bounding box of the face. Default attribute.
" }, "AgeRange": { "shape": "AgeRange", "documentation": "The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
" }, "Smile": { "shape": "Smile", "documentation": "Indicates whether or not the face is smiling, and the confidence level in the determination.
" }, "Eyeglasses": { "shape": "Eyeglasses", "documentation": "Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
" }, "Sunglasses": { "shape": "Sunglasses", "documentation": "Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
" }, "Gender": { "shape": "Gender", "documentation": "The predicted gender of a detected face.
" }, "Beard": { "shape": "Beard", "documentation": "Indicates whether or not the face has a beard, and the confidence level in the determination.
" }, "Mustache": { "shape": "Mustache", "documentation": "Indicates whether or not the face has a mustache, and the confidence level in the determination.
" }, "EyesOpen": { "shape": "EyeOpen", "documentation": "Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
" }, "MouthOpen": { "shape": "MouthOpen", "documentation": "Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
" }, "Emotions": { "shape": "Emotions", "documentation": "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.
" }, "Landmarks": { "shape": "Landmarks", "documentation": "Indicates the location of landmarks on the face. Default attribute.
" }, "Pose": { "shape": "Pose", "documentation": "Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
" }, "Quality": { "shape": "ImageQuality", "documentation": "Identifies image brightness and sharpness. Default attribute.
" }, "Confidence": { "shape": "Percent", "documentation": "Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
" }, "FaceOccluded": { "shape": "FaceOccluded", "documentation": " FaceOccluded should return \"true\" with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded should return \"false\" with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.
" } }, "documentation": "Structure containing attributes of the face that the algorithm detected.
A FaceDetail object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.
GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail object with all attributes. To specify which attributes to return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter:
GetCelebrityRecognition
GetPersonTracking
GetFaceSearch
The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the Attributes input parameter for DetectFaces. For IndexFaces, use the DetectAttributes input parameter.
Time, in milliseconds from the start of the video, that the face was detected. Note that Timestamp is not guaranteed to be accurate to the individual frame where the face first appears.
The face properties for the detected face.
" } }, "documentation": "Information about a face detected in a video analysis request and the time the face was detected in the video.
" }, "FaceDetections": { "type": "list", "member": { "shape": "FaceDetection" } }, "FaceId": { "type": "string", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "FaceIdList": { "type": "list", "member": { "shape": "FaceId" }, "max": 4096, "min": 1 }, "FaceList": { "type": "list", "member": { "shape": "Face" } }, "FaceMatch": { "type": "structure", "members": { "Similarity": { "shape": "Percent", "documentation": "Confidence in the match of this face with the input face.
" }, "Face": { "shape": "Face", "documentation": "Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.
" } }, "documentation": "Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.
" }, "FaceMatchList": { "type": "list", "member": { "shape": "FaceMatch" } }, "FaceModelVersionList": { "type": "list", "member": { "shape": "String" } }, "FaceOccluded": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "True if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. False if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that the service has detected the presence of a face occlusion.
" } }, "documentation": " FaceOccluded should return \"true\" with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded should return \"false\" with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.
You can use FaceOccluded to determine if an obstruction on a face negatively impacts using the image for face matching.
Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
" }, "FaceDetail": { "shape": "FaceDetail", "documentation": "Structure containing attributes of the face that the algorithm detected.
" } }, "documentation": "Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren't stored in the database.
" }, "FaceRecordList": { "type": "list", "member": { "shape": "FaceRecord" } }, "FaceSearchSettings": { "type": "structure", "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of a collection that contains faces that you want to search for.
" }, "FaceMatchThreshold": { "shape": "Percent", "documentation": "Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.
" } }, "documentation": "Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face recognition and the face attributes to detect. Defining the settings is required in the request parameter for CreateStreamProcessor.
" }, "FaceSearchSortBy": { "type": "string", "enum": [ "INDEX", "TIMESTAMP" ] }, "Float": { "type": "float" }, "FlowDefinitionArn": { "type": "string", "max": 256 }, "Gender": { "type": "structure", "members": { "Value": { "shape": "GenderType", "documentation": "The predicted gender of the face.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the prediction.
" } }, "documentation": "The predicted gender of a detected face.
Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.
Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.
We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.
" }, "GenderType": { "type": "string", "enum": [ "Male", "Female" ] }, "GeneralLabelsFilterList": { "type": "list", "member": { "shape": "GeneralLabelsFilterValue" }, "max": 100, "min": 0 }, "GeneralLabelsFilterValue": { "type": "string", "max": 50, "min": 0, "pattern": "[A-Za-z0-9àâèçñó'-_(). ]*" }, "GeneralLabelsSettings": { "type": "structure", "members": { "LabelInclusionFilters": { "shape": "GeneralLabelsFilterList", "documentation": "The labels that should be included in the return from DetectLabels.
" }, "LabelExclusionFilters": { "shape": "GeneralLabelsFilterList", "documentation": "The labels that should be excluded from the return from DetectLabels.
" }, "LabelCategoryInclusionFilters": { "shape": "GeneralLabelsFilterList", "documentation": "The label categories that should be included in the return from DetectLabels.
" }, "LabelCategoryExclusionFilters": { "shape": "GeneralLabelsFilterList", "documentation": "The label categories that should be excluded from the return from DetectLabels.
" } }, "documentation": "Contains filters for the object labels returned by DetectLabels. Filters can be inclusive, exclusive, or a combination of both and can be applied to individual labels or entire label categories. To see a list of label categories, see Detecting Labels.
" }, "Geometry": { "type": "structure", "members": { "BoundingBox": { "shape": "BoundingBox", "documentation": "An axis-aligned coarse representation of the detected item's location on the image.
" }, "Polygon": { "shape": "Polygon", "documentation": "Within the bounding box, a fine-grained polygon around the detected item.
" } }, "documentation": "Information about where an object (DetectCustomLabels) or text (DetectText) is located on an image.
" }, "GetCelebrityInfoRequest": { "type": "structure", "required": [ "Id" ], "members": { "Id": { "shape": "RekognitionUniqueId", "documentation": "The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
" } } }, "GetCelebrityInfoResponse": { "type": "structure", "members": { "Urls": { "shape": "Urls", "documentation": "An array of URLs pointing to additional celebrity information.
" }, "Name": { "shape": "String", "documentation": "The name of the celebrity.
" }, "KnownGender": { "shape": "KnownGender", "documentation": "Retrieves the known gender for the celebrity.
" } } }, "GetCelebrityRecognitionRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "SortBy": { "shape": "CelebrityRecognitionSortBy", "documentation": "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.
The current status of the celebrity recognition job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
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.
" }, "Celebrities": { "shape": "CelebrityRecognitions", "documentation": "Array of celebrities recognized in the video.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the celebrity recognition operation for which you want to obtain results. The job identifer is returned by an initial call to StartCelebrityRecognition.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GetContentModerationRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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 content moderation labels.
" }, "SortBy": { "shape": "ContentModerationSortBy", "documentation": "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.
Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
" } } }, "GetContentModerationRequestMetadata": { "type": "structure", "members": { "SortBy": { "shape": "ContentModerationSortBy", "documentation": "The sorting method chosen for a GetContentModeration request.
" }, "AggregateBy": { "shape": "ContentModerationAggregateBy", "documentation": "The aggregation method chosen for a GetContentModeration request.
" } }, "documentation": "Contains metadata about a content moderation request, including the SortBy and AggregateBy options.
" }, "GetContentModerationResponse": { "type": "structure", "members": { "JobStatus": { "shape": "VideoJobStatus", "documentation": "The current status of the content moderation analysis job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.
The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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 content moderation labels.
" }, "ModerationModelVersion": { "shape": "String", "documentation": "Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" }, "GetRequestMetadata": { "shape": "GetContentModerationRequestMetadata", "documentation": "Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
" } } }, "GetFaceDetectionRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" } } }, "GetFaceDetectionResponse": { "type": "structure", "members": { "JobStatus": { "shape": "VideoJobStatus", "documentation": "The current status of the face detection job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
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.
" }, "Faces": { "shape": "FaceDetections", "documentation": "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.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GetFaceLivenessSessionResultsRequest": { "type": "structure", "required": [ "SessionId" ], "members": { "SessionId": { "shape": "LivenessSessionId", "documentation": "A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an idempotency token for all operations associated with the session.
" } } }, "GetFaceLivenessSessionResultsResponse": { "type": "structure", "required": [ "SessionId", "Status" ], "members": { "SessionId": { "shape": "LivenessSessionId", "documentation": "The sessionId for which this request was called.
" }, "Status": { "shape": "LivenessSessionStatus", "documentation": "Represents a status corresponding to the state of the session. Possible statuses are: CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.
" }, "Confidence": { "shape": "Percent", "documentation": "Probabalistic confidence score for if the person in the given video was live, represented as a float value between 0 to 100.
" }, "ReferenceImage": { "shape": "AuditImage", "documentation": "A high-quality image from the Face Liveness video that can be used for face comparison or search. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. In case the reference image is not returned, it's recommended to retry the Liveness check.
" }, "AuditImages": { "shape": "AuditImages", "documentation": "A set of images from the Face Liveness video that can be used for audit purposes. It includes a bounding box of the face and the Base64-encoded bytes that return an image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image will be uploaded to an S3Object specified in the output configuration. If no Amazon S3 bucket is defined, raw bytes are sent instead.
" } } }, "GetFaceSearchRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "SortBy": { "shape": "FaceSearchSortBy", "documentation": "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.
The current status of the face search job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
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.
" }, "VideoMetadata": { "shape": "VideoMetadata", "documentation": "Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
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.
Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GetLabelDetectionRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "SortBy": { "shape": "LabelDetectionSortBy", "documentation": "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.
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
" } } }, "GetLabelDetectionRequestMetadata": { "type": "structure", "members": { "SortBy": { "shape": "LabelDetectionSortBy", "documentation": "The sorting method chosen for a GetLabelDetection request.
" }, "AggregateBy": { "shape": "LabelDetectionAggregateBy", "documentation": "The aggregation method chosen for a GetLabelDetection request.
" } }, "documentation": "Contains metadata about a label detection request, including the SortBy and AggregateBy options.
" }, "GetLabelDetectionResponse": { "type": "structure", "members": { "JobStatus": { "shape": "VideoJobStatus", "documentation": "The current status of the label detection job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
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.
" }, "Labels": { "shape": "LabelDetections", "documentation": "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.
" }, "LabelModelVersion": { "shape": "String", "documentation": "Version number of the label detection model that was used to detect labels.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" }, "GetRequestMetadata": { "shape": "GetLabelDetectionRequestMetadata", "documentation": "Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
" } } }, "GetMediaAnalysisJobRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "MediaAnalysisJobId", "documentation": "Unique identifier for the media analysis job for which you want to retrieve results.
" } } }, "GetMediaAnalysisJobResponse": { "type": "structure", "required": [ "JobId", "OperationsConfig", "Status", "CreationTimestamp", "Input", "OutputConfig" ], "members": { "JobId": { "shape": "MediaAnalysisJobId", "documentation": "The identifier for the media analysis job.
" }, "JobName": { "shape": "MediaAnalysisJobName", "documentation": "The name of the media analysis job.
" }, "OperationsConfig": { "shape": "MediaAnalysisOperationsConfig", "documentation": "Operation configurations that were provided during job creation.
" }, "Status": { "shape": "MediaAnalysisJobStatus", "documentation": "The current status of the media analysis job.
" }, "FailureDetails": { "shape": "MediaAnalysisJobFailureDetails", "documentation": "Details about the error that resulted in failure of the job.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix date and time when the job was started.
" }, "CompletionTimestamp": { "shape": "DateTime", "documentation": "The Unix date and time when the job finished.
" }, "Input": { "shape": "MediaAnalysisInput", "documentation": "Reference to the input manifest that was provided in the job creation request.
" }, "OutputConfig": { "shape": "MediaAnalysisOutputConfig", "documentation": "Output configuration that was provided in the creation request.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "KMS Key that was provided in the creation request.
" }, "Results": { "shape": "MediaAnalysisResults", "documentation": "Output manifest that contains prediction results.
" }, "ManifestSummary": { "shape": "MediaAnalysisManifestSummary", "documentation": "The summary manifest provides statistics on input manifest and errors identified in the input manifest.
" } } }, "GetPersonTrackingRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.
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.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "SortBy": { "shape": "PersonTrackingSortBy", "documentation": "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.
The current status of the person tracking job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.
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.
" }, "Persons": { "shape": "PersonDetections", "documentation": "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.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the person tracking operation for which you want to obtain results. The job identifer is returned by an initial call to StartPersonTracking.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GetSegmentDetectionRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartSegmentDetection.
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
" } } }, "GetSegmentDetectionResponse": { "type": "structure", "members": { "JobStatus": { "shape": "VideoJobStatus", "documentation": "Current status of the segment detection job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.
An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
" }, "Segments": { "shape": "SegmentDetections", "documentation": "An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.
An array containing the segment types requested in the call to StartSegmentDetection.
Job identifier for the segment detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartSegmentDetection.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartSegmentDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GetTextDetectionRequest": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "JobId", "documentation": "Job identifier for the text detection operation for which you want results returned. You get the job identifer from an initial call to StartTextDetection.
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
" } } }, "GetTextDetectionResponse": { "type": "structure", "members": { "JobStatus": { "shape": "VideoJobStatus", "documentation": "Current status of the text detection job.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "If the job fails, StatusMessage provides a descriptive error message.
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
" }, "TextModelVersion": { "shape": "String", "documentation": "Version number of the text detection model that was used to detect text.
" }, "JobId": { "shape": "JobId", "documentation": "Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.
" }, "Video": { "shape": "Video" }, "JobTag": { "shape": "JobTag", "documentation": "A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
" } } }, "GroundTruthBlob": { "type": "blob", "max": 5242880, "min": 1 }, "GroundTruthManifest": { "type": "structure", "members": { "S3Object": { "shape": "S3Object" } }, "documentation": "The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
" }, "HasErrors": { "type": "boolean" }, "HumanLoopActivationConditionsEvaluationResults": { "type": "string", "max": 10240 }, "HumanLoopActivationOutput": { "type": "structure", "members": { "HumanLoopArn": { "shape": "HumanLoopArn", "documentation": "The Amazon Resource Name (ARN) of the HumanLoop created.
" }, "HumanLoopActivationReasons": { "shape": "HumanLoopActivationReasons", "documentation": "Shows if and why human review was needed.
" }, "HumanLoopActivationConditionsEvaluationResults": { "shape": "HumanLoopActivationConditionsEvaluationResults", "documentation": "Shows the result of condition evaluations, including those conditions which activated a human review.
", "jsonvalue": true } }, "documentation": "Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
" }, "HumanLoopActivationReason": { "type": "string" }, "HumanLoopActivationReasons": { "type": "list", "member": { "shape": "HumanLoopActivationReason" }, "min": 1 }, "HumanLoopArn": { "type": "string", "max": 256 }, "HumanLoopConfig": { "type": "structure", "required": [ "HumanLoopName", "FlowDefinitionArn" ], "members": { "HumanLoopName": { "shape": "HumanLoopName", "documentation": "The name of the human review used for this image. This should be kept unique within a region.
" }, "FlowDefinitionArn": { "shape": "FlowDefinitionArn", "documentation": "The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.
" }, "DataAttributes": { "shape": "HumanLoopDataAttributes", "documentation": "Sets attributes of the input data.
" } }, "documentation": "Sets up the flow definition the image will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
" }, "HumanLoopDataAttributes": { "type": "structure", "members": { "ContentClassifiers": { "shape": "ContentClassifiers", "documentation": "Sets whether the input image is free of personally identifiable information.
" } }, "documentation": "Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information.
" }, "HumanLoopName": { "type": "string", "max": 63, "min": 1, "pattern": "^[a-z0-9](-*[a-z0-9])*" }, "Image": { "type": "structure", "members": { "Bytes": { "shape": "ImageBlob", "documentation": "Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.
Identifies an S3 object as the image source.
" } }, "documentation": "Provides the input image either as bytes or an S3 object.
You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.
For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.
You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.
" }, "ImageBlob": { "type": "blob", "max": 5242880, "min": 1 }, "ImageId": { "type": "string", "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "ImageQuality": { "type": "structure", "members": { "Brightness": { "shape": "Float", "documentation": "Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
" }, "Sharpness": { "shape": "Float", "documentation": "Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
" } }, "documentation": "Identifies face image brightness and sharpness.
" }, "IndexFacesModelVersion": { "type": "string", "pattern": "[0-9\\.]+" }, "IndexFacesRequest": { "type": "structure", "required": [ "CollectionId", "Image" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection to which you want to add the faces that are detected in the input images.
" }, "Image": { "shape": "Image", "documentation": "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.
The ID you want to assign to all the faces detected in the image.
" }, "DetectionAttributes": { "shape": "Attributes", "documentation": "An array of facial attributes you want to be returned. A DEFAULT subset of facial attributes - BoundingBox, Confidence, Pose, Quality, and Landmarks - will always be returned. You can request for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\", \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all facial attributes by using [\"ALL\"]. Requesting more attributes may increase response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).
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.
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" } } }, "IndexFacesResponse": { "type": "structure", "members": { "FaceRecords": { "shape": "FaceRecordList", "documentation": "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.
" }, "OrientationCorrection": { "shape": "OrientationCorrection", "documentation": "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.
The version number of the face detection model that's associated with the input collection (CollectionId).
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.
The position of the label instance on the image.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that Amazon Rekognition has in the accuracy of the bounding box.
" }, "DominantColors": { "shape": "DominantColors", "documentation": "The dominant colors found in an individual instance of a label.
" } }, "documentation": "An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).
" }, "Instances": { "type": "list", "member": { "shape": "Instance" } }, "IsLabeled": { "type": "boolean" }, "JobId": { "type": "string", "max": 64, "min": 1, "pattern": "^[a-zA-Z0-9-_]+$" }, "JobTag": { "type": "string", "max": 1024, "min": 1, "pattern": "[a-zA-Z0-9_.\\-:+=\\/]+" }, "KinesisDataArn": { "type": "string", "pattern": "(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)" }, "KinesisDataStream": { "type": "structure", "members": { "Arn": { "shape": "KinesisDataArn", "documentation": "ARN of the output Amazon Kinesis Data Streams stream.
" } }, "documentation": "The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
" }, "KinesisVideoArn": { "type": "string", "pattern": "(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)" }, "KinesisVideoStream": { "type": "structure", "members": { "Arn": { "shape": "KinesisVideoArn", "documentation": "ARN of the Kinesis video stream stream that streams the source video.
" } }, "documentation": "Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
" }, "KinesisVideoStreamFragmentNumber": { "type": "string", "max": 128, "min": 1, "pattern": "^[0-9]+$" }, "KinesisVideoStreamStartSelector": { "type": "structure", "members": { "ProducerTimestamp": { "shape": "ULong", "documentation": "The timestamp from the producer corresponding to the fragment, in milliseconds, expressed in unix time format.
" }, "FragmentNumber": { "shape": "KinesisVideoStreamFragmentNumber", "documentation": "The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
" } }, "documentation": "Specifies the starting point in a Kinesis stream to start processing. You can use the producer timestamp or the fragment number. One of either producer timestamp or fragment number is required. If you use the producer timestamp, you must put the time in milliseconds. For more information about fragment numbers, see Fragment.
" }, "KmsKeyId": { "type": "string", "max": 2048, "min": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" }, "KnownGender": { "type": "structure", "members": { "Type": { "shape": "KnownGenderType", "documentation": "A string value of the KnownGender info about the Celebrity.
" } }, "documentation": "The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.
" }, "KnownGenderType": { "type": "string", "documentation": "A list of enum string of possible gender values that Celebrity returns.
", "enum": [ "Male", "Female", "Nonbinary", "Unlisted" ] }, "Label": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name (label) of the object or scene.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence.
" }, "Instances": { "shape": "Instances", "documentation": "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.
The parent labels for a label. The response includes all ancestor labels.
" }, "Aliases": { "shape": "LabelAliases", "documentation": "A list of potential aliases for a given label.
" }, "Categories": { "shape": "LabelCategories", "documentation": "A list of the categories associated with a given label.
" } }, "documentation": "Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.
" }, "LabelAlias": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "
The name of an alias for a given label.
" } }, "documentation": "A potential alias of for a given label.
" }, "LabelAliases": { "type": "list", "member": { "shape": "LabelAlias" } }, "LabelCategories": { "type": "list", "member": { "shape": "LabelCategory" } }, "LabelCategory": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of a category that applies to a given label.
" } }, "documentation": "The category that applies to a given label.
" }, "LabelDetection": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "Time, in milliseconds from the start of the video, that the label was detected. Note that Timestamp is not guaranteed to be accurate to the individual frame where the label first appears.
Details about the detected label.
" }, "StartTimestampMillis": { "shape": "ULong", "documentation": "The time in milliseconds defining the start of the timeline segment containing a continuously detected label.
" }, "EndTimestampMillis": { "shape": "ULong", "documentation": "The time in milliseconds defining the end of the timeline segment containing a continuously detected label.
" }, "DurationMillis": { "shape": "ULong", "documentation": "The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.
" } }, "documentation": "Information about a label detected in a video analysis request and the time the label was detected in the video.
" }, "LabelDetectionAggregateBy": { "type": "string", "enum": [ "TIMESTAMPS", "SEGMENTS" ] }, "LabelDetectionFeatureList": { "type": "list", "member": { "shape": "LabelDetectionFeatureName" }, "max": 1, "min": 0 }, "LabelDetectionFeatureName": { "type": "string", "enum": [ "GENERAL_LABELS" ] }, "LabelDetectionSettings": { "type": "structure", "members": { "GeneralLabels": { "shape": "GeneralLabelsSettings" } }, "documentation": "Contains the specified filters that should be applied to a list of returned GENERAL_LABELS.
" }, "LabelDetectionSortBy": { "type": "string", "enum": [ "NAME", "TIMESTAMP" ] }, "LabelDetections": { "type": "list", "member": { "shape": "LabelDetection" } }, "Labels": { "type": "list", "member": { "shape": "Label" } }, "Landmark": { "type": "structure", "members": { "Type": { "shape": "LandmarkType", "documentation": "Type of landmark.
" }, "X": { "shape": "Float", "documentation": "The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
" }, "Y": { "shape": "Float", "documentation": "The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.
" } }, "documentation": "Indicates the location of the landmark on the face.
" }, "LandmarkType": { "type": "string", "enum": [ "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" ] }, "Landmarks": { "type": "list", "member": { "shape": "Landmark" } }, "ListCollectionsRequest": { "type": "structure", "members": { "NextToken": { "shape": "PaginationToken", "documentation": "Pagination token from the previous response.
" }, "MaxResults": { "shape": "PageSize", "documentation": "Maximum number of collection IDs to return.
" } } }, "ListCollectionsResponse": { "type": "structure", "members": { "CollectionIds": { "shape": "CollectionIdList", "documentation": "An array of collection IDs.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
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].
The Amazon Resource Name (ARN) for the dataset that you want to use.
" }, "ContainsLabels": { "shape": "DatasetLabels", "documentation": "Specifies a label filter for the response. The response includes an entry only if one or more of the labels in ContainsLabels exist in the entry.
Specify true to get only the JSON Lines where the image is labeled. Specify false to get only the JSON Lines where the image isn't labeled. If you don't specify Labeled, ListDatasetEntries returns JSON Lines for labeled and unlabeled images.
If specified, ListDatasetEntries only returns JSON Lines where the value of SourceRefContains is part of the source-ref field. The source-ref field contains the Amazon S3 location of the image. You can use SouceRefContains for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.
Specifies an error filter for the response. Specify True to only include entries that have errors.
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" }, "MaxResults": { "shape": "ListDatasetEntriesPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
" } } }, "ListDatasetEntriesResponse": { "type": "structure", "members": { "DatasetEntries": { "shape": "DatasetEntries", "documentation": "A list of entries (images) in the dataset.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" } } }, "ListDatasetLabelsPageSize": { "type": "integer", "max": 100, "min": 1 }, "ListDatasetLabelsRequest": { "type": "structure", "required": [ "DatasetArn" ], "members": { "DatasetArn": { "shape": "DatasetArn", "documentation": "The Amazon Resource Name (ARN) of the dataset that you want to use.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" }, "MaxResults": { "shape": "ListDatasetLabelsPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
" } } }, "ListDatasetLabelsResponse": { "type": "structure", "members": { "DatasetLabelDescriptions": { "shape": "DatasetLabelDescriptions", "documentation": "A list of the labels in the dataset.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" } } }, "ListFacesRequest": { "type": "structure", "required": [ "CollectionId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "ID of the collection from which to list the faces.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "MaxResults": { "shape": "PageSize", "documentation": "Maximum number of faces to return.
" }, "UserId": { "shape": "UserId", "documentation": "An array of user IDs to filter results with when listing faces in a collection.
" }, "FaceIds": { "shape": "FaceIdList", "documentation": "An array of face IDs to filter results with when listing faces in a collection.
" } } }, "ListFacesResponse": { "type": "structure", "members": { "Faces": { "shape": "FaceList", "documentation": "An array of Face objects.
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.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the input collection (CollectionId).
Pagination token, if the previous response was incomplete.
" }, "MaxResults": { "shape": "ListMediaAnalysisJobsPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value user can specify is 100. If user specifies a value greater than 100, an InvalidParameterException error occurs. The default value is 100.
Pagination token, if the previous response was incomplete.
" }, "MediaAnalysisJobs": { "shape": "MediaAnalysisJobDescriptions", "documentation": "Contains a list of all media analysis jobs.
" } } }, "ListProjectPoliciesPageSize": { "type": "integer", "max": 5, "min": 1 }, "ListProjectPoliciesRequest": { "type": "structure", "required": [ "ProjectArn" ], "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The ARN of the project for which you want to list the project policies.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
" }, "MaxResults": { "shape": "ListProjectPoliciesPageSize", "documentation": "The maximum number of results to return per paginated call. The largest value you can specify is 5. If you specify a value greater than 5, a ValidationException error occurs. The default value is 5.
" } } }, "ListProjectPoliciesResponse": { "type": "structure", "members": { "ProjectPolicies": { "shape": "ProjectPolicies", "documentation": "A list of project policies attached to the project.
" }, "NextToken": { "shape": "ExtendedPaginationToken", "documentation": "If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of project policies.
" } } }, "ListStreamProcessorsRequest": { "type": "structure", "members": { "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "MaxResults": { "shape": "MaxResults", "documentation": "Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
" } } }, "ListStreamProcessorsResponse": { "type": "structure", "members": { "NextToken": { "shape": "PaginationToken", "documentation": "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.
" }, "StreamProcessors": { "shape": "StreamProcessorList", "documentation": "List of stream processors that you have created.
" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.
" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "TagMap", "documentation": "A list of key-value tags assigned to the resource.
" } } }, "ListUsersRequest": { "type": "structure", "required": [ "CollectionId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection.
" }, "MaxResults": { "shape": "MaxUserResults", "documentation": "Maximum number of UsersID to return.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "Pagingation token to receive the next set of UsersID.
" } } }, "ListUsersResponse": { "type": "structure", "members": { "Users": { "shape": "UserList", "documentation": "List of UsersID associated with the specified collection.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "A pagination token to be used with the subsequent request if the response is truncated.
" } } }, "LivenessImageBlob": { "type": "blob", "max": 204800, "min": 1, "sensitive": true }, "LivenessOutputConfig": { "type": "structure", "required": [ "S3Bucket" ], "members": { "S3Bucket": { "shape": "S3Bucket", "documentation": "The path to an AWS Amazon S3 bucket used to store Face Liveness session results.
" }, "S3KeyPrefix": { "shape": "LivenessS3KeyPrefix", "documentation": "The prefix prepended to the output files for the Face Liveness session results.
" } }, "documentation": "Contains settings that specify the location of an Amazon S3 bucket used to store the output of a Face Liveness session. Note that the S3 bucket must be located in the caller's AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system.
" }, "LivenessS3KeyPrefix": { "type": "string", "max": 950, "pattern": "\\S*" }, "LivenessSessionId": { "type": "string", "max": 36, "min": 36, "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "LivenessSessionStatus": { "type": "string", "enum": [ "CREATED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "EXPIRED" ] }, "MatchedUser": { "type": "structure", "members": { "UserId": { "shape": "UserId", "documentation": "A provided ID for the UserID. Unique within the collection.
" }, "UserStatus": { "shape": "UserStatus", "documentation": "The status of the user matched to a provided FaceID.
" } }, "documentation": "Contains metadata for a UserID matched with a given face.
" }, "MaxDurationInSecondsULong": { "type": "long", "max": 120, "min": 1 }, "MaxFaces": { "type": "integer", "max": 4096, "min": 1 }, "MaxFacesToIndex": { "type": "integer", "min": 1 }, "MaxPixelThreshold": { "type": "float", "max": 1, "min": 0 }, "MaxResults": { "type": "integer", "min": 1 }, "MaxUserResults": { "type": "integer", "max": 500, "min": 1 }, "MediaAnalysisDetectModerationLabelsConfig": { "type": "structure", "members": { "MinConfidence": { "shape": "Percent", "documentation": "Specifies the minimum confidence level for the moderation labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.
" }, "ProjectVersion": { "shape": "ProjectVersionId", "documentation": "Specifies the custom moderation model to be used during the label detection job. If not provided the pre-trained model is used.
" } }, "documentation": "Configuration for Moderation Labels Detection.
" }, "MediaAnalysisInput": { "type": "structure", "required": [ "S3Object" ], "members": { "S3Object": { "shape": "S3Object" } }, "documentation": "Contains input information for a media analysis job.
" }, "MediaAnalysisJobDescription": { "type": "structure", "required": [ "JobId", "OperationsConfig", "Status", "CreationTimestamp", "Input", "OutputConfig" ], "members": { "JobId": { "shape": "MediaAnalysisJobId", "documentation": "The identifier for a media analysis job.
" }, "JobName": { "shape": "MediaAnalysisJobName", "documentation": "The name of a media analysis job.
" }, "OperationsConfig": { "shape": "MediaAnalysisOperationsConfig", "documentation": "Operation configurations that were provided during job creation.
" }, "Status": { "shape": "MediaAnalysisJobStatus", "documentation": "The status of the media analysis job being retrieved.
" }, "FailureDetails": { "shape": "MediaAnalysisJobFailureDetails", "documentation": "Details about the error that resulted in failure of the job.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix date and time when the job was started.
" }, "CompletionTimestamp": { "shape": "DateTime", "documentation": "The Unix date and time when the job finished.
" }, "Input": { "shape": "MediaAnalysisInput", "documentation": "Reference to the input manifest that was provided in the job creation request.
" }, "OutputConfig": { "shape": "MediaAnalysisOutputConfig", "documentation": "Output configuration that was provided in the creation request.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "KMS Key that was provided in the creation request.
" }, "Results": { "shape": "MediaAnalysisResults", "documentation": "Output manifest that contains prediction results.
" }, "ManifestSummary": { "shape": "MediaAnalysisManifestSummary", "documentation": "Provides statistics on input manifest and errors identified in the input manifest.
" } }, "documentation": "Description for a media analysis job.
" }, "MediaAnalysisJobDescriptions": { "type": "list", "member": { "shape": "MediaAnalysisJobDescription" } }, "MediaAnalysisJobFailureCode": { "type": "string", "enum": [ "INTERNAL_ERROR", "INVALID_S3_OBJECT", "INVALID_MANIFEST", "INVALID_OUTPUT_CONFIG", "INVALID_KMS_KEY", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "RESOURCE_NOT_READY", "THROTTLED" ] }, "MediaAnalysisJobFailureDetails": { "type": "structure", "members": { "Code": { "shape": "MediaAnalysisJobFailureCode", "documentation": "Error code for the failed job.
" }, "Message": { "shape": "String", "documentation": "Human readable error message.
" } }, "documentation": "Details about the error that resulted in failure of the job.
" }, "MediaAnalysisJobId": { "type": "string", "max": 64, "min": 1, "pattern": "^[a-zA-Z0-9-_]+$" }, "MediaAnalysisJobName": { "type": "string", "max": 64, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "MediaAnalysisJobStatus": { "type": "string", "enum": [ "CREATED", "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "MediaAnalysisManifestSummary": { "type": "structure", "members": { "S3Object": { "shape": "S3Object" } }, "documentation": "Summary that provides statistics on input manifest and errors identified in the input manifest.
" }, "MediaAnalysisModelVersions": { "type": "structure", "members": { "Moderation": { "shape": "String", "documentation": "The Moderation base model version.
" } }, "documentation": "Object containing information about the model versions of selected features in a given job.
" }, "MediaAnalysisOperationsConfig": { "type": "structure", "members": { "DetectModerationLabels": { "shape": "MediaAnalysisDetectModerationLabelsConfig", "documentation": "Contains configuration options for a DetectModerationLabels job.
" } }, "documentation": "Configuration options for a media analysis job. Configuration is operation-specific.
" }, "MediaAnalysisOutputConfig": { "type": "structure", "required": [ "S3Bucket" ], "members": { "S3Bucket": { "shape": "S3Bucket", "documentation": "Specifies the Amazon S3 bucket to contain the output of the media analysis job.
" }, "S3KeyPrefix": { "shape": "MediaAnalysisS3KeyPrefix", "documentation": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for storage.
" } }, "documentation": "Output configuration provided in the job creation request.
" }, "MediaAnalysisResults": { "type": "structure", "members": { "S3Object": { "shape": "S3Object" }, "ModelVersions": { "shape": "MediaAnalysisModelVersions", "documentation": "Information about the model versions for the features selected in a given job.
" } }, "documentation": "Contains the results for a media analysis job created with StartMediaAnalysisJob.
" }, "MediaAnalysisS3KeyPrefix": { "type": "string", "max": 800, "pattern": "\\S*" }, "MinCoveragePercentage": { "type": "float", "max": 100, "min": 0 }, "ModerationLabel": { "type": "structure", "members": { "Confidence": { "shape": "Percent", "documentation": "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.
The label name for the type of unsafe content detected in the image.
" }, "ParentName": { "shape": "String", "documentation": "The name for the parent label. Labels at the top level of the hierarchy have the parent label \"\".
The level of the moderation label with regard to its taxonomy, from 1 to 3.
" } }, "documentation": "Provides information about a single type of inappropriate, unwanted, or offensive content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition Developer Guide.
" }, "ModerationLabels": { "type": "list", "member": { "shape": "ModerationLabel" } }, "MouthOpen": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the mouth on the face is open or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
" }, "Mustache": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the face has mustache or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the face has a mustache, and the confidence level in the determination.
" }, "NotificationChannel": { "type": "structure", "required": [ "SNSTopicArn", "RoleArn" ], "members": { "SNSTopicArn": { "shape": "SNSTopicArn", "documentation": "The Amazon SNS topic to which Amazon Rekognition posts the completion status.
" }, "RoleArn": { "shape": "RoleArn", "documentation": "The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.
" } }, "documentation": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.
" }, "OrientationCorrection": { "type": "string", "enum": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ] }, "OutputConfig": { "type": "structure", "members": { "S3Bucket": { "shape": "S3Bucket", "documentation": "The S3 bucket where training output is placed.
" }, "S3KeyPrefix": { "shape": "S3KeyPrefix", "documentation": "The prefix applied to the training output files.
" } }, "documentation": "The S3 bucket and folder location where training output is placed.
" }, "PageSize": { "type": "integer", "max": 4096, "min": 0 }, "PaginationToken": { "type": "string", "max": 255 }, "Parent": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the parent label.
" } }, "documentation": "A parent label for a label. A label can have 0, 1, or more parents.
" }, "Parents": { "type": "list", "member": { "shape": "Parent" } }, "Percent": { "type": "float", "max": 100, "min": 0 }, "PersonDetail": { "type": "structure", "members": { "Index": { "shape": "PersonIndex", "documentation": "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.
" }, "BoundingBox": { "shape": "BoundingBox", "documentation": "Bounding box around the detected person.
" }, "Face": { "shape": "FaceDetail", "documentation": "Face details for the detected person.
" } }, "documentation": "Details about a person detected in a video analysis request.
" }, "PersonDetection": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The time, in milliseconds from the start of the video, that the person's path was tracked. Note that Timestamp is not guaranteed to be accurate to the individual frame where the person's path first appears.
Details about a person whose path was tracked in a video.
" } }, "documentation": "Details and path tracking information for a single time a person's path is tracked in a video. Amazon Rekognition operations that track people's paths return an array of PersonDetection objects with elements for each time a person's path is tracked in a video.
For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.
" }, "PersonDetections": { "type": "list", "member": { "shape": "PersonDetection" } }, "PersonIndex": { "type": "long" }, "PersonMatch": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The time, in milliseconds from the beginning of the video, that the person was matched in the video.
" }, "Person": { "shape": "PersonDetail", "documentation": "Information about the matched person.
" }, "FaceMatches": { "shape": "FaceMatchList", "documentation": "Information about the faces in the input collection that match the face of a person in the video.
" } }, "documentation": "Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch objects is returned by GetFaceSearch.
The value of the X coordinate for a point on a Polygon.
The value of the Y coordinate for a point on a Polygon.
The X and Y coordinates of a point on an image or video frame. The X and Y values are ratios of the overall image size or video resolution. For example, if an input image is 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.
An array of Point objects makes up a Polygon. A Polygon is returned by DetectText and by DetectCustomLabels Polygon represents a fine-grained polygon around a detected item. For more information, see Geometry in the Amazon Rekognition Developer Guide.
Value representing the face rotation on the roll axis.
" }, "Yaw": { "shape": "Degree", "documentation": "Value representing the face rotation on the yaw axis.
" }, "Pitch": { "shape": "Degree", "documentation": "Value representing the face rotation on the pitch axis.
" } }, "documentation": "Indicates the pose of the face as determined by its pitch, roll, and yaw.
" }, "ProjectArn": { "type": "string", "max": 2048, "min": 20, "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)" }, "ProjectAutoUpdate": { "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "ProjectDescription": { "type": "structure", "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the project.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix timestamp for the date and time that the project was created.
" }, "Status": { "shape": "ProjectStatus", "documentation": "The current status of the project.
" }, "Datasets": { "shape": "DatasetMetadataList", "documentation": "Information about the training and test datasets in the project.
" }, "Feature": { "shape": "CustomizationFeature", "documentation": "Specifies the project that is being customized.
" }, "AutoUpdate": { "shape": "ProjectAutoUpdate", "documentation": "Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.
" } }, "documentation": "A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.
" }, "ProjectDescriptions": { "type": "list", "member": { "shape": "ProjectDescription" } }, "ProjectName": { "type": "string", "max": 255, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "ProjectNames": { "type": "list", "member": { "shape": "ProjectName" }, "max": 10, "min": 1 }, "ProjectPolicies": { "type": "list", "member": { "shape": "ProjectPolicy" } }, "ProjectPolicy": { "type": "structure", "members": { "ProjectArn": { "shape": "ProjectArn", "documentation": "The Amazon Resource Name (ARN) of the project to which the project policy is attached.
" }, "PolicyName": { "shape": "ProjectPolicyName", "documentation": "The name of the project policy.
" }, "PolicyRevisionId": { "shape": "ProjectPolicyRevisionId", "documentation": "The revision ID of the project policy.
" }, "PolicyDocument": { "shape": "ProjectPolicyDocument", "documentation": "The JSON document for the project policy.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix datetime for the creation of the project policy.
" }, "LastUpdatedTimestamp": { "shape": "DateTime", "documentation": "The Unix datetime for when the project policy was last updated.
" } }, "documentation": "Describes a project policy in the response from ListProjectPolicies.
" }, "ProjectPolicyDocument": { "type": "string", "max": 2000, "min": 1, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "ProjectPolicyName": { "type": "string", "max": 128, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "ProjectPolicyRevisionId": { "type": "string", "max": 64, "pattern": "[0-9A-Fa-f]+" }, "ProjectStatus": { "type": "string", "enum": [ "CREATING", "CREATED", "DELETING" ] }, "ProjectVersionArn": { "type": "string", "max": 2048, "min": 20, "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)" }, "ProjectVersionDescription": { "type": "structure", "members": { "ProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "
The Amazon Resource Name (ARN) of the project version.
" }, "CreationTimestamp": { "shape": "DateTime", "documentation": "The Unix datetime for the date and time that training started.
" }, "MinInferenceUnits": { "shape": "InferenceUnits", "documentation": "The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
" }, "Status": { "shape": "ProjectVersionStatus", "documentation": "The current status of the model version.
" }, "StatusMessage": { "shape": "StatusMessage", "documentation": "A descriptive message for an error or warning that occurred.
" }, "BillableTrainingTimeInSeconds": { "shape": "ULong", "documentation": "The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.
" }, "TrainingEndTimestamp": { "shape": "DateTime", "documentation": "The Unix date and time that training of the model ended.
" }, "OutputConfig": { "shape": "OutputConfig", "documentation": "The location where training results are saved.
" }, "TrainingDataResult": { "shape": "TrainingDataResult", "documentation": "Contains information about the training results.
" }, "TestingDataResult": { "shape": "TestingDataResult", "documentation": "Contains information about the testing results.
" }, "EvaluationResult": { "shape": "EvaluationResult", "documentation": "The training results. EvaluationResult is only returned if training is successful.
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.
" }, "MaxInferenceUnits": { "shape": "InferenceUnits", "documentation": "The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies only to Custom Labels projects. For more information, see StartProjectVersion.
" }, "SourceProjectVersionArn": { "shape": "ProjectVersionArn", "documentation": "If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.
A user-provided description of the project version.
" }, "Feature": { "shape": "CustomizationFeature", "documentation": "The feature that was customized.
" }, "BaseModelVersion": { "shape": "String", "documentation": "The base detection model version used to create the project version.
" }, "FeatureConfig": { "shape": "CustomizationFeatureConfig", "documentation": "Feature specific configuration that was applied during training.
" } }, "documentation": "A description of a version of a Amazon Rekognition project version.
" }, "ProjectVersionDescriptions": { "type": "list", "member": { "shape": "ProjectVersionDescription" } }, "ProjectVersionId": { "type": "string", "max": 2048, "min": 20, "pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)" }, "ProjectVersionStatus": { "type": "string", "enum": [ "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING", "COPYING_IN_PROGRESS", "COPYING_COMPLETED", "COPYING_FAILED", "DEPRECATED", "EXPIRED" ] }, "ProjectVersionsPageSize": { "type": "integer", "max": 100, "min": 1 }, "ProjectsPageSize": { "type": "integer", "max": 100, "min": 1 }, "ProtectiveEquipmentBodyPart": { "type": "structure", "members": { "Name": { "shape": "BodyPart", "documentation": "The detected body part.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
" }, "EquipmentDetections": { "shape": "EquipmentDetections", "documentation": "An array of Personal Protective Equipment items detected around a body part.
" } }, "documentation": "Information about a body part detected by DetectProtectiveEquipment that contains PPE. An array of ProtectiveEquipmentBodyPart objects is returned for each person detected by DetectProtectiveEquipment.
An array of body parts detected on a person's body (including body parts without PPE).
" }, "BoundingBox": { "shape": "BoundingBox", "documentation": "A bounding box around the detected person.
" }, "Confidence": { "shape": "Percent", "documentation": "The confidence that Amazon Rekognition has that the bounding box contains a person.
" }, "Id": { "shape": "UInteger", "documentation": "The identifier for the detected person. The identifier is only unique for a single call to DetectProtectiveEquipment.
A person detected by a call to DetectProtectiveEquipment. The API returns all persons detected in the input image in an array of ProtectiveEquipmentPerson objects.
The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.
Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.
" }, "RequiredEquipmentTypes": { "shape": "ProtectiveEquipmentTypes", "documentation": "
An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.
Specifies summary attributes to return from a call to DetectProtectiveEquipment. You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections. Summary information is returned in the Summary (ProtectiveEquipmentSummary) field of the response from DetectProtectiveEquipment. The summary includes which persons in an image were detected wearing the requested types of person protective equipment (PPE), which persons were detected as not wearing PPE, and the persons in which a determination could not be made. For more information, see ProtectiveEquipmentSummary.
An array of IDs for persons who are wearing detected personal protective equipment.
" }, "PersonsWithoutRequiredEquipment": { "shape": "ProtectiveEquipmentPersonIds", "documentation": "An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.
An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.
" } }, "documentation": "Summary information for required items of personal protective equipment (PPE) detected on persons by a call to DetectProtectiveEquipment. You specify the required type of PPE in the SummarizationAttributes (ProtectiveEquipmentSummarizationAttributes) input parameter. The summary includes which persons were detected wearing the required personal protective equipment (PersonsWithRequiredEquipment), which persons were detected as not wearing the required PPE (PersonsWithoutRequiredEquipment), and the persons in which a determination could not be made (PersonsIndeterminate).
To get a total for each category, use the size of the field array. For example, to find out how many people were detected as wearing the specified PPE, use the size of the PersonsWithRequiredEquipment array. If you want to find out more about a person, such as the location (BoundingBox) of the person on the image, use the person ID in each array element. Each person ID matches the ID field of a ProtectiveEquipmentPerson object returned in the Persons array by DetectProtectiveEquipment.
The Amazon Resource Name (ARN) of the project that the project policy is attached to.
" }, "PolicyName": { "shape": "ProjectPolicyName", "documentation": "A name for the policy.
" }, "PolicyRevisionId": { "shape": "ProjectPolicyRevisionId", "documentation": "The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels generates and assigns a new PolicyRevisionId and then deletes the previous version of the policy.
A resource policy to add to the model. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference.
" } } }, "PutProjectPolicyResponse": { "type": "structure", "members": { "PolicyRevisionId": { "shape": "ProjectPolicyRevisionId", "documentation": "The ID of the project policy.
" } } }, "QualityFilter": { "type": "string", "enum": [ "NONE", "AUTO", "LOW", "MEDIUM", "HIGH" ] }, "QueryString": { "type": "string", "max": 2048, "min": 1, "pattern": ".*\\S.*" }, "Reason": { "type": "string", "enum": [ "EXCEEDS_MAX_FACES", "EXTREME_POSE", "LOW_BRIGHTNESS", "LOW_SHARPNESS", "LOW_CONFIDENCE", "SMALL_BOUNDING_BOX", "LOW_FACE_QUALITY" ] }, "Reasons": { "type": "list", "member": { "shape": "Reason" } }, "RecognizeCelebritiesRequest": { "type": "structure", "required": [ "Image" ], "members": { "Image": { "shape": "Image", "documentation": "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.
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality, Smile, Id, KnownGender, MatchConfidence, Name, Urls.
Details about each unrecognized face in the image.
" }, "OrientationCorrection": { "shape": "OrientationCorrection", "documentation": "Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
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.
The box representing a region of interest on screen.
" }, "Polygon": { "shape": "Polygon", "documentation": " Specifies a shape made up of up to 10 Point objects to define a region of interest.
Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set a region of the screen.
A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.
" }, "RegionsOfInterest": { "type": "list", "member": { "shape": "RegionOfInterest" }, "max": 10, "min": 0 }, "RekognitionUniqueId": { "type": "string", "pattern": "[0-9A-Za-z]*" }, "ResourceArn": { "type": "string", "max": 2048, "min": 20 }, "RoleArn": { "type": "string", "pattern": "arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "S3Bucket": { "type": "string", "max": 255, "min": 3, "pattern": "[0-9A-Za-z\\.\\-_]*" }, "S3Destination": { "type": "structure", "members": { "Bucket": { "shape": "S3Bucket", "documentation": "The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.
" }, "KeyPrefix": { "shape": "S3KeyPrefix", "documentation": "The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.
" } }, "documentation": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. These results include the name of the stream processor resource, the session ID of the stream processing session, and labeled timestamps and bounding boxes for detected labels.
" }, "S3KeyPrefix": { "type": "string", "max": 1024 }, "S3Object": { "type": "structure", "members": { "Bucket": { "shape": "S3Bucket", "documentation": "Name of the S3 bucket.
" }, "Name": { "shape": "S3ObjectName", "documentation": "S3 object key name.
" }, "Version": { "shape": "S3ObjectVersion", "documentation": "If the bucket is versioning enabled, you can specify the object version.
" } }, "documentation": "Provides the S3 bucket name and object name.
The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.
For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.
" }, "S3ObjectName": { "type": "string", "max": 1024, "min": 1 }, "S3ObjectVersion": { "type": "string", "max": 1024, "min": 1 }, "SNSTopicArn": { "type": "string", "pattern": "(^arn:aws:sns:.*:\\w{12}:.+$)" }, "SearchFacesByImageRequest": { "type": "structure", "required": [ "CollectionId", "Image" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "ID of the collection to search.
" }, "Image": { "shape": "Image", "documentation": "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.
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
" }, "FaceMatchThreshold": { "shape": "Percent", "documentation": "(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%.
" }, "QualityFilter": { "shape": "QualityFilter", "documentation": "A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
" } } }, "SearchFacesByImageResponse": { "type": "structure", "members": { "SearchedFaceBoundingBox": { "shape": "BoundingBox", "documentation": "The bounding box around the face in the input image that Amazon Rekognition used for the search.
" }, "SearchedFaceConfidence": { "shape": "Percent", "documentation": "The level of confidence that the searchedFaceBoundingBox, contains a face.
An array of faces that match the input face, along with the confidence in the match.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the input collection (CollectionId).
ID of the collection the face belongs to.
" }, "FaceId": { "shape": "FaceId", "documentation": "ID of a face to find matches for in the collection.
" }, "MaxFaces": { "shape": "MaxFaces", "documentation": "Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
" }, "FaceMatchThreshold": { "shape": "Percent", "documentation": "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%.
" } } }, "SearchFacesResponse": { "type": "structure", "members": { "SearchedFaceId": { "shape": "FaceId", "documentation": "ID of the face that was searched for matches in a collection.
" }, "FaceMatches": { "shape": "FaceMatchList", "documentation": "An array of faces that matched the input face, along with the confidence in the match.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the input collection (CollectionId).
The ID of an existing collection containing the UserID.
" }, "Image": { "shape": "Image" }, "UserMatchThreshold": { "shape": "Percent", "documentation": "Specifies the minimum confidence in the UserID match to return. Default value is 80.
" }, "MaxUsers": { "shape": "MaxUserResults", "documentation": "Maximum number of UserIDs to return.
" }, "QualityFilter": { "shape": "QualityFilter", "documentation": "A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. The default value is NONE.
" } } }, "SearchUsersByImageResponse": { "type": "structure", "members": { "UserMatches": { "shape": "UserMatchList", "documentation": "An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the input collection CollectionId.
" }, "SearchedFace": { "shape": "SearchedFaceDetails", "documentation": "A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.
" }, "UnsearchedFaces": { "shape": "UnsearchedFacesList", "documentation": "List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.
" } } }, "SearchUsersRequest": { "type": "structure", "required": [ "CollectionId" ], "members": { "CollectionId": { "shape": "CollectionId", "documentation": "The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.
" }, "UserId": { "shape": "UserId", "documentation": "ID for the existing User.
" }, "FaceId": { "shape": "FaceId", "documentation": "ID for the existing face.
" }, "UserMatchThreshold": { "shape": "Percent", "documentation": "Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.
" }, "MaxUsers": { "shape": "MaxUserResults", "documentation": "Maximum number of identities to return.
" } } }, "SearchUsersResponse": { "type": "structure", "members": { "UserMatches": { "shape": "UserMatchList", "documentation": "An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.
" }, "FaceModelVersion": { "shape": "String", "documentation": "Version number of the face detection model associated with the input CollectionId.
" }, "SearchedFace": { "shape": "SearchedFace", "documentation": "Contains the ID of a face that was used to search for matches in a collection.
" }, "SearchedUser": { "shape": "SearchedUser", "documentation": "Contains the ID of the UserID that was used to search for matches in a collection.
" } } }, "SearchedFace": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "Unique identifier assigned to the face.
" } }, "documentation": "Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.
" }, "SearchedFaceDetails": { "type": "structure", "members": { "FaceDetail": { "shape": "FaceDetail" } }, "documentation": "Contains data regarding the input face used for a search.
" }, "SearchedUser": { "type": "structure", "members": { "UserId": { "shape": "UserId", "documentation": "A provided ID for the UserID. Unique within the collection.
" } }, "documentation": "Contains metadata about a User searched for within a collection.
" }, "SegmentConfidence": { "type": "float", "max": 100, "min": 50 }, "SegmentDetection": { "type": "structure", "members": { "Type": { "shape": "SegmentType", "documentation": "The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
The start time of the detected segment in milliseconds from the start of the video. This value is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of 100 millis.
" }, "EndTimestampMillis": { "shape": "Timestamp", "documentation": "The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
" }, "DurationMillis": { "shape": "ULong", "documentation": "The duration of the detected segment in milliseconds.
" }, "StartTimecodeSMPTE": { "shape": "Timecode", "documentation": "The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment. StartTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. EndTimecode is in HH:MM:SS:fr format (and ;fr for drop frame-rates).
The duration of the timecode for the detected segment in SMPTE format.
" }, "TechnicalCueSegment": { "shape": "TechnicalCueSegment", "documentation": "If the segment is a technical cue, contains information about the technical cue.
" }, "ShotSegment": { "shape": "ShotSegment", "documentation": "If the segment is a shot detection, contains information about the shot detection.
" }, "StartFrameNumber": { "shape": "ULong", "documentation": "The frame number of the start of a video segment, using a frame index that starts with 0.
" }, "EndFrameNumber": { "shape": "ULong", "documentation": "The frame number at the end of a video segment, using a frame index that starts with 0.
" }, "DurationFrames": { "shape": "ULong", "documentation": "The duration of a video segment, expressed in frames.
" } }, "documentation": "A technical cue or shot detection segment detected in a video. An array of SegmentDetection objects containing all segments detected in a stored video is returned by GetSegmentDetection.
The type of a segment (technical cue or shot detection).
" }, "ModelVersion": { "shape": "String", "documentation": "The version of the model used to detect segments.
" } }, "documentation": "Information about the type of a segment requested in a call to StartSegmentDetection. An array of SegmentTypeInfo objects is returned by the response from GetSegmentDetection.
An Identifier for a shot detection segment detected in a video.
" }, "Confidence": { "shape": "SegmentConfidence", "documentation": "The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
" } }, "documentation": "Information about a shot detection segment detected in a video. For more information, see SegmentDetection.
" }, "Smile": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the face is smiling or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the face is smiling, and the confidence level in the determination.
" }, "StartCelebrityRecognitionRequest": { "type": "structure", "required": [ "Video" ], "members": { "Video": { "shape": "Video", "documentation": "The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "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.
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.
The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored in an Amazon S3 bucket.
" }, "MinConfidence": { "shape": "Percent", "documentation": "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.
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.
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
The identifier for the content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.
The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "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.
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
" }, "FaceAttributes": { "shape": "FaceAttributes", "documentation": "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.
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.
The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.
The video you want to search. The video must be stored in an Amazon S3 bucket.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "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.
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%.
" }, "CollectionId": { "shape": "CollectionId", "documentation": "ID of the collection that contains the faces you want to search for.
" }, "NotificationChannel": { "shape": "NotificationChannel", "documentation": "The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.
The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "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.
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 and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
" }, "Settings": { "shape": "LabelDetectionSettings", "documentation": "The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.
" } } }, "StartLabelDetectionResponse": { "type": "structure", "members": { "JobId": { "shape": "JobId", "documentation": "The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.
Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
The name of the job. Does not have to be unique.
" }, "OperationsConfig": { "shape": "MediaAnalysisOperationsConfig", "documentation": "Configuration options for the media analysis job to be created.
" }, "Input": { "shape": "MediaAnalysisInput", "documentation": "Input data to be analyzed by the job.
" }, "OutputConfig": { "shape": "MediaAnalysisOutputConfig", "documentation": "The Amazon S3 bucket location to store the results.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.
" } } }, "StartMediaAnalysisJobResponse": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "shape": "MediaAnalysisJobId", "documentation": "Identifier for the created job.
" } } }, "StartPersonTrackingRequest": { "type": "structure", "required": [ "Video" ], "members": { "Video": { "shape": "Video", "documentation": "The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "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.
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.
The Amazon Resource Name(ARN) of the model version that you want to start.
" }, "MinInferenceUnits": { "shape": "InferenceUnits", "documentation": "The minimum number of inference units to use. A single inference unit represents 1 hour of processing.
Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
" }, "MaxInferenceUnits": { "shape": "InferenceUnits", "documentation": "The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.
" } } }, "StartProjectVersionResponse": { "type": "structure", "members": { "Status": { "shape": "ProjectVersionStatus", "documentation": "The current running status of the model.
" } } }, "StartSegmentDetectionFilters": { "type": "structure", "members": { "TechnicalCueFilter": { "shape": "StartTechnicalCueDetectionFilter", "documentation": "Filters that are specific to technical cues.
" }, "ShotFilter": { "shape": "StartShotDetectionFilter", "documentation": "Filters that are specific to shot detections.
" } }, "documentation": "Filters applied to the technical cue or shot detection segments. For more information, see StartSegmentDetection.
" }, "StartSegmentDetectionRequest": { "type": "structure", "required": [ "Video", "SegmentTypes" ], "members": { "Video": { "shape": "Video" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
" }, "JobTag": { "shape": "JobTag", "documentation": "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.
Filters for technical cue or shot detection.
" }, "SegmentTypes": { "shape": "SegmentTypes", "documentation": "An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
" } } }, "StartSegmentDetectionResponse": { "type": "structure", "members": { "JobId": { "shape": "JobId", "documentation": "Unique identifier for the segment detection job. The JobId is returned from StartSegmentDetection.
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.
If you don't specify MinSegmentConfidence, the GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.
Filters for the shot detection segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.
The name of the stream processor to start processing.
" }, "StartSelector": { "shape": "StreamProcessingStartSelector", "documentation": "Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds. For more information about fragment numbers, see Fragment.
This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" }, "StopSelector": { "shape": "StreamProcessingStopSelector", "documentation": "Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.
This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" } } }, "StartStreamProcessorResponse": { "type": "structure", "members": { "SessionId": { "shape": "StartStreamProcessorSessionId", "documentation": "A unique identifier for the stream processing session.
" } } }, "StartStreamProcessorSessionId": { "type": "string" }, "StartTechnicalCueDetectionFilter": { "type": "structure", "members": { "MinSegmentConfidence": { "shape": "SegmentConfidence", "documentation": "Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level lower than this specified value.
If you don't specify MinSegmentConfidence, GetSegmentDetection returns segments with confidence values greater than or equal to 50 percent.
A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame. Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.
" } }, "documentation": "Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.
" }, "StartTextDetectionFilters": { "type": "structure", "members": { "WordFilter": { "shape": "DetectionFilter", "documentation": "Filters focusing on qualities of the text, such as confidence or size.
" }, "RegionsOfInterest": { "shape": "RegionsOfInterest", "documentation": "Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.
Set of optional parameters that let you set the criteria text must meet to be included in your response. WordFilter looks at a word's height, width and minimum confidence. RegionOfInterest lets you set a specific region of the screen to look for text in.
Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.
An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
Optional parameters that let you set criteria the text must meet to be included in your response.
" } } }, "StartTextDetectionResponse": { "type": "structure", "members": { "JobId": { "shape": "JobId", "documentation": "Identifier for the text detection job. Use JobId to identify the job in a subsequent call to GetTextDetection.
The Amazon Resource Name (ARN) of the model version that you want to stop.
This operation requires permissions to perform the rekognition:StopProjectVersion action.
The current status of the stop operation.
" } } }, "StopStreamProcessorRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "StreamProcessorName", "documentation": "The name of a stream processor created by CreateStreamProcessor.
" } } }, "StopStreamProcessorResponse": { "type": "structure", "members": {} }, "StreamProcessingStartSelector": { "type": "structure", "members": { "KVSStreamStartSelector": { "shape": "KinesisVideoStreamStartSelector", "documentation": "Specifies the starting point in the stream to start processing. This can be done with a producer timestamp or a fragment number in a Kinesis stream.
" } }, "documentation": "This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.
" }, "StreamProcessingStopSelector": { "type": "structure", "members": { "MaxDurationInSeconds": { "shape": "MaxDurationInSecondsULong", "documentation": "Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.
" } }, "documentation": "Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.
" }, "StreamProcessor": { "type": "structure", "members": { "Name": { "shape": "StreamProcessorName", "documentation": "Name of the Amazon Rekognition stream processor.
" }, "Status": { "shape": "StreamProcessorStatus", "documentation": "Current status of the Amazon Rekognition stream processor.
" } }, "documentation": "An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
If this option is set to true, you choose to share data with Rekognition to improve model performance.
" } }, "documentation": "Allows you to opt in or opt out to share data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.
" }, "StreamProcessorInput": { "type": "structure", "members": { "KinesisVideoStream": { "shape": "KinesisVideoStream", "documentation": "The Kinesis video stream input stream for the source streaming video.
" } }, "documentation": "Information about the source streaming video.
" }, "StreamProcessorList": { "type": "list", "member": { "shape": "StreamProcessor" } }, "StreamProcessorName": { "type": "string", "max": 128, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "StreamProcessorNotificationChannel": { "type": "structure", "required": [ "SNSTopicArn" ], "members": { "SNSTopicArn": { "shape": "SNSTopicArn", "documentation": "The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.
" } }, "documentation": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.
Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.
Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.
" }, "StreamProcessorOutput": { "type": "structure", "members": { "KinesisDataStream": { "shape": "KinesisDataStream", "documentation": "The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
" }, "S3Destination": { "shape": "S3Destination", "documentation": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
" } }, "documentation": "Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
" }, "StreamProcessorParameterToDelete": { "type": "string", "enum": [ "ConnectedHomeMinConfidence", "RegionsOfInterest" ] }, "StreamProcessorParametersToDelete": { "type": "list", "member": { "shape": "StreamProcessorParameterToDelete" } }, "StreamProcessorSettings": { "type": "structure", "members": { "FaceSearch": { "shape": "FaceSearchSettings", "documentation": "Face search settings to use on a streaming video.
" }, "ConnectedHome": { "shape": "ConnectedHomeSettings" } }, "documentation": "Input parameters used in a streaming video analyzed by a Amazon Rekognition stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.
The label detection settings you want to use for your stream processor.
" } }, "documentation": " The stream processor settings that you want to update. ConnectedHome settings can be updated to detect different labels with a different minimum confidence.
The S3 bucket that contains the training summary. The training summary includes aggregated evaluation metrics for the entire testing dataset and metrics for each individual label.
You get the training summary S3 bucket location by calling DescribeProjectVersions.
" }, "Sunglasses": { "type": "structure", "members": { "Value": { "shape": "Boolean", "documentation": "Boolean value that indicates whether the face is wearing sunglasses or not.
" }, "Confidence": { "shape": "Percent", "documentation": "Level of confidence in the determination.
" } }, "documentation": "Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
" }, "TagKey": { "type": "string", "max": 128, "min": 1, "pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 200, "min": 0 }, "TagMap": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" }, "max": 200, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to assign the tags to.
" }, "Tags": { "shape": "TagMap", "documentation": "The key-value tags to assign to the resource.
" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagValue": { "type": "string", "max": 256, "min": 0, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TechnicalCueSegment": { "type": "structure", "members": { "Type": { "shape": "TechnicalCueType", "documentation": "The type of the technical cue.
" }, "Confidence": { "shape": "SegmentConfidence", "documentation": "The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
" } }, "documentation": "Information about a technical cue segment. For more information, see SegmentDetection.
" }, "TechnicalCueType": { "type": "string", "enum": [ "ColorBars", "EndCredits", "BlackFrames", "OpeningCredits", "StudioLogo", "Slate", "Content" ] }, "TestingData": { "type": "structure", "members": { "Assets": { "shape": "Assets", "documentation": "The assets used for testing.
" }, "AutoCreate": { "shape": "Boolean", "documentation": "If specified, Rekognition splits training dataset to create a test dataset for the training job.
" } }, "documentation": "The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition uses the training dataset to create a test dataset with a temporary split of the training dataset.
The testing dataset that was supplied for training.
" }, "Output": { "shape": "TestingData", "documentation": "The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.
" }, "Validation": { "shape": "ValidationData", "documentation": "The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.
" } }, "documentation": "Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.
" }, "TextDetection": { "type": "structure", "members": { "DetectedText": { "shape": "String", "documentation": "The word or line of text recognized by Amazon Rekognition.
" }, "Type": { "shape": "TextTypes", "documentation": "The type of text that was detected.
" }, "Id": { "shape": "UInteger", "documentation": "The identifier for the detected text. The identifier is only unique for a single call to DetectText.
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.
The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
" }, "Geometry": { "shape": "Geometry", "documentation": "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.
" } }, "documentation": "Information about a word or line of text detected by DetectText.
The DetectedText field contains the text that Amazon Rekognition detected in the image.
Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.
For more information, see Detecting text in the Amazon Rekognition Developer Guide.
" }, "TextDetectionList": { "type": "list", "member": { "shape": "TextDetection" } }, "TextDetectionResult": { "type": "structure", "members": { "Timestamp": { "shape": "Timestamp", "documentation": "The time, in milliseconds from the start of the video, that the text was detected. Note that Timestamp is not guaranteed to be accurate to the individual frame where the text first appears.
Details about text detected in a video.
" } }, "documentation": "Information about text detected in a video. Incudes the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
" }, "TextDetectionResults": { "type": "list", "member": { "shape": "TextDetectionResult" } }, "TextTypes": { "type": "string", "enum": [ "LINE", "WORD" ] }, "Timecode": { "type": "string" }, "Timestamp": { "type": "long" }, "TrainingData": { "type": "structure", "members": { "Assets": { "shape": "Assets", "documentation": "A manifest file that contains references to the training images and ground-truth annotations.
" } }, "documentation": "The dataset used for training.
" }, "TrainingDataResult": { "type": "structure", "members": { "Input": { "shape": "TrainingData", "documentation": "The training data that you supplied.
" }, "Output": { "shape": "TrainingData", "documentation": "Reference to images (assets) that were actually used during training with trained model predictions.
" }, "Validation": { "shape": "ValidationData", "documentation": "A manifest that you supplied for training, with validation results for each line.
" } }, "documentation": "The data validation manifest created for the training dataset during model training.
" }, "UInteger": { "type": "integer", "min": 0 }, "ULong": { "type": "long", "min": 0 }, "UnindexedFace": { "type": "structure", "members": { "Reasons": { "shape": "Reasons", "documentation": "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.
The structure that contains attributes of a face that IndexFacesdetected, but didn't index.
A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to determine why a face wasn't indexed.
Reasons why a face wasn't used for Search.
" } }, "documentation": "Face details inferred from the image but not used for search. The response attribute contains reasons for why a face wasn't used for Search.
" }, "UnsearchedFaceReason": { "type": "string", "enum": [ "FACE_NOT_LARGEST", "EXCEEDS_MAX_FACES", "EXTREME_POSE", "LOW_BRIGHTNESS", "LOW_SHARPNESS", "LOW_CONFIDENCE", "SMALL_BOUNDING_BOX", "LOW_FACE_QUALITY" ] }, "UnsearchedFaceReasons": { "type": "list", "member": { "shape": "UnsearchedFaceReason" } }, "UnsearchedFacesList": { "type": "list", "member": { "shape": "UnsearchedFace" } }, "UnsuccessfulFaceAssociation": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "A unique identifier assigned to the face.
" }, "UserId": { "shape": "UserId", "documentation": "A provided ID for the UserID. Unique within the collection.
" }, "Confidence": { "shape": "Percent", "documentation": "Match confidence with the UserID, provides information regarding if a face association was unsuccessful because it didn't meet UserMatchThreshold.
" }, "Reasons": { "shape": "UnsuccessfulFaceAssociationReasons", "documentation": "The reason why the association was unsuccessful.
" } }, "documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.
" }, "UnsuccessfulFaceAssociationList": { "type": "list", "member": { "shape": "UnsuccessfulFaceAssociation" }, "max": 500, "min": 0 }, "UnsuccessfulFaceAssociationReason": { "type": "string", "enum": [ "FACE_NOT_FOUND", "ASSOCIATED_TO_A_DIFFERENT_USER", "LOW_MATCH_CONFIDENCE" ] }, "UnsuccessfulFaceAssociationReasons": { "type": "list", "member": { "shape": "UnsuccessfulFaceAssociationReason" } }, "UnsuccessfulFaceDeletion": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "A unique identifier assigned to the face.
" }, "UserId": { "shape": "UserId", "documentation": "A provided ID for the UserID. Unique within the collection.
" }, "Reasons": { "shape": "UnsuccessfulFaceDeletionReasons", "documentation": "The reason why the deletion was unsuccessful.
" } }, "documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.
" }, "UnsuccessfulFaceDeletionReason": { "type": "string", "enum": [ "ASSOCIATED_TO_AN_EXISTING_USER", "FACE_NOT_FOUND" ] }, "UnsuccessfulFaceDeletionReasons": { "type": "list", "member": { "shape": "UnsuccessfulFaceDeletionReason" } }, "UnsuccessfulFaceDeletionsList": { "type": "list", "member": { "shape": "UnsuccessfulFaceDeletion" }, "max": 4096, "min": 0 }, "UnsuccessfulFaceDisassociation": { "type": "structure", "members": { "FaceId": { "shape": "FaceId", "documentation": "A unique identifier assigned to the face.
" }, "UserId": { "shape": "UserId", "documentation": "A provided ID for the UserID. Unique within the collection.
" }, "Reasons": { "shape": "UnsuccessfulFaceDisassociationReasons", "documentation": "The reason why the deletion was unsuccessful.
" } }, "documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.
" }, "UnsuccessfulFaceDisassociationList": { "type": "list", "member": { "shape": "UnsuccessfulFaceDisassociation" }, "max": 500, "min": 0 }, "UnsuccessfulFaceDisassociationReason": { "type": "string", "enum": [ "FACE_NOT_FOUND", "ASSOCIATED_TO_A_DIFFERENT_USER" ] }, "UnsuccessfulFaceDisassociationReasons": { "type": "list", "member": { "shape": "UnsuccessfulFaceDisassociationReason" } }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "TagKeys" ], "members": { "ResourceArn": { "shape": "ResourceArn", "documentation": "Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to remove the tags from.
" }, "TagKeys": { "shape": "TagKeyList", "documentation": "A list of the tags that you want to remove.
" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateDatasetEntriesRequest": { "type": "structure", "required": [ "DatasetArn", "Changes" ], "members": { "DatasetArn": { "shape": "DatasetArn", "documentation": "The Amazon Resource Name (ARN) of the dataset that you want to update.
" }, "Changes": { "shape": "DatasetChanges", "documentation": "The changes that you want to make to the dataset.
" } } }, "UpdateDatasetEntriesResponse": { "type": "structure", "members": {} }, "UpdateStreamProcessorRequest": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "StreamProcessorName", "documentation": "Name of the stream processor that you want to update.
" }, "SettingsForUpdate": { "shape": "StreamProcessorSettingsForUpdate", "documentation": "The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.
" }, "RegionsOfInterestForUpdate": { "shape": "RegionsOfInterest", "documentation": "Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
" }, "DataSharingPreferenceForUpdate": { "shape": "StreamProcessorDataSharingPreference", "documentation": "Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.
" }, "ParametersToDelete": { "shape": "StreamProcessorParametersToDelete", "documentation": "A list of parameters you want to delete from the stream processor.
" } } }, "UpdateStreamProcessorResponse": { "type": "structure", "members": {} }, "Url": { "type": "string" }, "Urls": { "type": "list", "member": { "shape": "Url" }, "max": 255, "min": 0 }, "User": { "type": "structure", "members": { "UserId": { "shape": "UserId", "documentation": "A provided ID for the User. Unique within the collection.
" }, "UserStatus": { "shape": "UserStatus", "documentation": "Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.
" } }, "documentation": "Metadata of the user stored in a collection.
" }, "UserFaceIdList": { "type": "list", "member": { "shape": "FaceId" }, "max": 100, "min": 1 }, "UserId": { "type": "string", "max": 128, "min": 1, "pattern": "[a-zA-Z0-9_.\\-:]+" }, "UserList": { "type": "list", "member": { "shape": "User" }, "max": 500 }, "UserMatch": { "type": "structure", "members": { "Similarity": { "shape": "Percent", "documentation": "Describes the UserID metadata.
" }, "User": { "shape": "MatchedUser", "documentation": "Confidence in the match of this UserID with the input face.
" } }, "documentation": "Provides UserID metadata along with the confidence in the match of this UserID with the input face.
" }, "UserMatchList": { "type": "list", "member": { "shape": "UserMatch" }, "max": 500 }, "UserStatus": { "type": "string", "enum": [ "ACTIVE", "UPDATING", "CREATING", "CREATED" ] }, "ValidationData": { "type": "structure", "members": { "Assets": { "shape": "Assets", "documentation": "The assets that comprise the validation data.
" } }, "documentation": "Contains the Amazon S3 bucket location of the validation data for a model training job.
The validation data includes error information for individual JSON Lines in the dataset. For more information, see Debugging a Failed Model Training in the Amazon Rekognition Custom Labels Developer Guide.
You get the ValidationData object for the training dataset (TrainingDataResult) and the test dataset (TestingDataResult) by calling DescribeProjectVersions.
The assets array contains a single Asset object. The GroundTruthManifest field of the Asset object contains the S3 bucket location of the validation data.
" }, "VersionDescription": { "type": "string", "max": 255, "min": 1, "pattern": "[a-zA-Z0-9-_. ()':,;?]+" }, "VersionName": { "type": "string", "max": 255, "min": 1, "pattern": "[a-zA-Z0-9_.\\-]+" }, "VersionNames": { "type": "list", "member": { "shape": "VersionName" }, "max": 10, "min": 1 }, "Video": { "type": "structure", "members": { "S3Object": { "shape": "S3Object", "documentation": "The Amazon S3 bucket name and file name for the video.
" } }, "documentation": "Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
Type of compression used in the analyzed video.
" }, "DurationMillis": { "shape": "ULong", "documentation": "Length of the video in milliseconds.
" }, "Format": { "shape": "String", "documentation": "Format of the analyzed video. Possible values are MP4, MOV and AVI.
" }, "FrameRate": { "shape": "Float", "documentation": "Number of frames per second in the video.
" }, "FrameHeight": { "shape": "ULong", "documentation": "Vertical pixel dimension of the video.
" }, "FrameWidth": { "shape": "ULong", "documentation": "Horizontal pixel dimension of the video.
" }, "ColorRange": { "shape": "VideoColorRange", "documentation": "A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).
" } }, "documentation": "Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common errors.
Amazon Rekognition Image
Amazon Rekognition Custom Labels
Amazon Rekognition Video Stored Video
Amazon Rekognition Video Streaming Video
" }