# Amazon Rekognition
<a name="API_Types_Amazon_Rekognition"></a>

The following data types are supported by Amazon Rekognition:
+  [AgeRange](API_AgeRange.md) 
+  [Asset](API_Asset.md) 
+  [AssociatedFace](API_AssociatedFace.md) 
+  [AudioMetadata](API_AudioMetadata.md) 
+  [AuditImage](API_AuditImage.md) 
+  [Beard](API_Beard.md) 
+  [BlackFrame](API_BlackFrame.md) 
+  [BoundingBox](API_BoundingBox.md) 
+  [Celebrity](API_Celebrity.md) 
+  [CelebrityDetail](API_CelebrityDetail.md) 
+  [CelebrityRecognition](API_CelebrityRecognition.md) 
+  [Challenge](API_Challenge.md) 
+  [ChallengePreference](API_ChallengePreference.md) 
+  [ComparedFace](API_ComparedFace.md) 
+  [ComparedSourceImageFace](API_ComparedSourceImageFace.md) 
+  [CompareFacesMatch](API_CompareFacesMatch.md) 
+  [ConnectedHomeSettings](API_ConnectedHomeSettings.md) 
+  [ConnectedHomeSettingsForUpdate](API_ConnectedHomeSettingsForUpdate.md) 
+  [ContentModerationDetection](API_ContentModerationDetection.md) 
+  [ContentType](API_ContentType.md) 
+  [CoversBodyPart](API_CoversBodyPart.md) 
+  [CreateFaceLivenessSessionRequestSettings](API_CreateFaceLivenessSessionRequestSettings.md) 
+  [CustomizationFeatureConfig](API_CustomizationFeatureConfig.md) 
+  [CustomizationFeatureContentModerationConfig](API_CustomizationFeatureContentModerationConfig.md) 
+  [CustomLabel](API_CustomLabel.md) 
+  [DatasetChanges](API_DatasetChanges.md) 
+  [DatasetDescription](API_DatasetDescription.md) 
+  [DatasetLabelDescription](API_DatasetLabelDescription.md) 
+  [DatasetLabelStats](API_DatasetLabelStats.md) 
+  [DatasetMetadata](API_DatasetMetadata.md) 
+  [DatasetSource](API_DatasetSource.md) 
+  [DatasetStats](API_DatasetStats.md) 
+  [DetectionFilter](API_DetectionFilter.md) 
+  [DetectLabelsImageBackground](API_DetectLabelsImageBackground.md) 
+  [DetectLabelsImageForeground](API_DetectLabelsImageForeground.md) 
+  [DetectLabelsImageProperties](API_DetectLabelsImageProperties.md) 
+  [DetectLabelsImagePropertiesSettings](API_DetectLabelsImagePropertiesSettings.md) 
+  [DetectLabelsImageQuality](API_DetectLabelsImageQuality.md) 
+  [DetectLabelsSettings](API_DetectLabelsSettings.md) 
+  [DetectTextFilters](API_DetectTextFilters.md) 
+  [DisassociatedFace](API_DisassociatedFace.md) 
+  [DistributeDataset](API_DistributeDataset.md) 
+  [DominantColor](API_DominantColor.md) 
+  [Emotion](API_Emotion.md) 
+  [EquipmentDetection](API_EquipmentDetection.md) 
+  [EvaluationResult](API_EvaluationResult.md) 
+  [EyeDirection](API_EyeDirection.md) 
+  [Eyeglasses](API_Eyeglasses.md) 
+  [EyeOpen](API_EyeOpen.md) 
+  [Face](API_Face.md) 
+  [FaceDetail](API_FaceDetail.md) 
+  [FaceDetection](API_FaceDetection.md) 
+  [FaceMatch](API_FaceMatch.md) 
+  [FaceOccluded](API_FaceOccluded.md) 
+  [FaceRecord](API_FaceRecord.md) 
+  [FaceSearchSettings](API_FaceSearchSettings.md) 
+  [Gender](API_Gender.md) 
+  [GeneralLabelsSettings](API_GeneralLabelsSettings.md) 
+  [Geometry](API_Geometry.md) 
+  [GetContentModerationRequestMetadata](API_GetContentModerationRequestMetadata.md) 
+  [GetLabelDetectionRequestMetadata](API_GetLabelDetectionRequestMetadata.md) 
+  [GroundTruthManifest](API_GroundTruthManifest.md) 
+  [HumanLoopActivationOutput](API_HumanLoopActivationOutput.md) 
+  [HumanLoopConfig](API_HumanLoopConfig.md) 
+  [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) 
+  [Image](API_Image.md) 
+  [ImageQuality](API_ImageQuality.md) 
+  [Instance](API_Instance.md) 
+  [KinesisDataStream](API_KinesisDataStream.md) 
+  [KinesisVideoStream](API_KinesisVideoStream.md) 
+  [KinesisVideoStreamStartSelector](API_KinesisVideoStreamStartSelector.md) 
+  [KnownGender](API_KnownGender.md) 
+  [Label](API_Label.md) 
+  [LabelAlias](API_LabelAlias.md) 
+  [LabelCategory](API_LabelCategory.md) 
+  [LabelDetection](API_LabelDetection.md) 
+  [LabelDetectionSettings](API_LabelDetectionSettings.md) 
+  [Landmark](API_Landmark.md) 
+  [LivenessOutputConfig](API_LivenessOutputConfig.md) 
+  [MatchedUser](API_MatchedUser.md) 
+  [MediaAnalysisDetectModerationLabelsConfig](API_MediaAnalysisDetectModerationLabelsConfig.md) 
+  [MediaAnalysisInput](API_MediaAnalysisInput.md) 
+  [MediaAnalysisJobDescription](API_MediaAnalysisJobDescription.md) 
+  [MediaAnalysisJobFailureDetails](API_MediaAnalysisJobFailureDetails.md) 
+  [MediaAnalysisManifestSummary](API_MediaAnalysisManifestSummary.md) 
+  [MediaAnalysisModelVersions](API_MediaAnalysisModelVersions.md) 
+  [MediaAnalysisOperationsConfig](API_MediaAnalysisOperationsConfig.md) 
+  [MediaAnalysisOutputConfig](API_MediaAnalysisOutputConfig.md) 
+  [MediaAnalysisResults](API_MediaAnalysisResults.md) 
+  [ModerationLabel](API_ModerationLabel.md) 
+  [MouthOpen](API_MouthOpen.md) 
+  [Mustache](API_Mustache.md) 
+  [NotificationChannel](API_NotificationChannel.md) 
+  [OutputConfig](API_OutputConfig.md) 
+  [Parent](API_Parent.md) 
+  [PersonDetail](API_PersonDetail.md) 
+  [PersonDetection](API_PersonDetection.md) 
+  [PersonMatch](API_PersonMatch.md) 
+  [Point](API_Point.md) 
+  [Pose](API_Pose.md) 
+  [ProjectDescription](API_ProjectDescription.md) 
+  [ProjectPolicy](API_ProjectPolicy.md) 
+  [ProjectVersionDescription](API_ProjectVersionDescription.md) 
+  [ProtectiveEquipmentBodyPart](API_ProtectiveEquipmentBodyPart.md) 
+  [ProtectiveEquipmentPerson](API_ProtectiveEquipmentPerson.md) 
+  [ProtectiveEquipmentSummarizationAttributes](API_ProtectiveEquipmentSummarizationAttributes.md) 
+  [ProtectiveEquipmentSummary](API_ProtectiveEquipmentSummary.md) 
+  [RegionOfInterest](API_RegionOfInterest.md) 
+  [S3Destination](API_S3Destination.md) 
+  [S3Object](API_S3Object.md) 
+  [SearchedFace](API_SearchedFace.md) 
+  [SearchedFaceDetails](API_SearchedFaceDetails.md) 
+  [SearchedUser](API_SearchedUser.md) 
+  [SegmentDetection](API_SegmentDetection.md) 
+  [SegmentTypeInfo](API_SegmentTypeInfo.md) 
+  [ShotSegment](API_ShotSegment.md) 
+  [Smile](API_Smile.md) 
+  [StartSegmentDetectionFilters](API_StartSegmentDetectionFilters.md) 
+  [StartShotDetectionFilter](API_StartShotDetectionFilter.md) 
+  [StartTechnicalCueDetectionFilter](API_StartTechnicalCueDetectionFilter.md) 
+  [StartTextDetectionFilters](API_StartTextDetectionFilters.md) 
+  [StreamProcessingStartSelector](API_StreamProcessingStartSelector.md) 
+  [StreamProcessingStopSelector](API_StreamProcessingStopSelector.md) 
+  [StreamProcessor](API_StreamProcessor.md) 
+  [StreamProcessorDataSharingPreference](API_StreamProcessorDataSharingPreference.md) 
+  [StreamProcessorInput](API_StreamProcessorInput.md) 
+  [StreamProcessorNotificationChannel](API_StreamProcessorNotificationChannel.md) 
+  [StreamProcessorOutput](API_StreamProcessorOutput.md) 
+  [StreamProcessorSettings](API_StreamProcessorSettings.md) 
+  [StreamProcessorSettingsForUpdate](API_StreamProcessorSettingsForUpdate.md) 
+  [Summary](API_Summary.md) 
+  [Sunglasses](API_Sunglasses.md) 
+  [TechnicalCueSegment](API_TechnicalCueSegment.md) 
+  [TestingData](API_TestingData.md) 
+  [TestingDataResult](API_TestingDataResult.md) 
+  [TextDetection](API_TextDetection.md) 
+  [TextDetectionResult](API_TextDetectionResult.md) 
+  [TrainingData](API_TrainingData.md) 
+  [TrainingDataResult](API_TrainingDataResult.md) 
+  [UnindexedFace](API_UnindexedFace.md) 
+  [UnsearchedFace](API_UnsearchedFace.md) 
+  [UnsuccessfulFaceAssociation](API_UnsuccessfulFaceAssociation.md) 
+  [UnsuccessfulFaceDeletion](API_UnsuccessfulFaceDeletion.md) 
+  [UnsuccessfulFaceDisassociation](API_UnsuccessfulFaceDisassociation.md) 
+  [User](API_User.md) 
+  [UserMatch](API_UserMatch.md) 
+  [ValidationData](API_ValidationData.md) 
+  [Versions](API_Versions.md) 
+  [Video](API_Video.md) 
+  [VideoMetadata](API_VideoMetadata.md) 

# AgeRange
<a name="API_AgeRange"></a>

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.

## Contents
<a name="API_AgeRange_Contents"></a>

 ** High **   <a name="rekognition-Type-AgeRange-High"></a>
The highest estimated age.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Low **   <a name="rekognition-Type-AgeRange-Low"></a>
The lowest estimated age.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_AgeRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/AgeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/AgeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/AgeRange) 

# Asset
<a name="API_Asset"></a>

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. 

## Contents
<a name="API_Asset_Contents"></a>

 ** GroundTruthManifest **   <a name="rekognition-Type-Asset-GroundTruthManifest"></a>
The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.   
Type: [GroundTruthManifest](API_GroundTruthManifest.md) object  
Required: No

## See Also
<a name="API_Asset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Asset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Asset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Asset) 

# AssociatedFace
<a name="API_AssociatedFace"></a>

Provides face metadata for the faces that are associated to a specific UserID.

## Contents
<a name="API_AssociatedFace_Contents"></a>

 ** FaceId **   <a name="rekognition-Type-AssociatedFace-FaceId"></a>
Unique identifier assigned to the face.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_AssociatedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/AssociatedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/AssociatedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/AssociatedFace) 

# AudioMetadata
<a name="API_AudioMetadata"></a>

Metadata information about an audio stream. An array of `AudioMetadata` objects for the audio streams found in a stored video is returned by [GetSegmentDetection](API_GetSegmentDetection.md). 

## Contents
<a name="API_AudioMetadata_Contents"></a>

 ** Codec **   <a name="rekognition-Type-AudioMetadata-Codec"></a>
The audio codec used to encode or decode the audio stream.   
Type: String  
Required: No

 ** DurationMillis **   <a name="rekognition-Type-AudioMetadata-DurationMillis"></a>
The duration of the audio stream in milliseconds.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** NumberOfChannels **   <a name="rekognition-Type-AudioMetadata-NumberOfChannels"></a>
The number of audio channels in the segment.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** SampleRate **   <a name="rekognition-Type-AudioMetadata-SampleRate"></a>
The sample rate for the audio stream.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_AudioMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/AudioMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/AudioMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/AudioMetadata) 

# AuditImage
<a name="API_AuditImage"></a>

An image that is picked from the Face Liveness video and returned for audit trail purposes, returned as Base64-encoded bytes.

## Contents
<a name="API_AuditImage_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-AuditImage-BoundingBox"></a>
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. 
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Bytes **   <a name="rekognition-Type-AuditImage-Bytes"></a>
The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 204800.  
Required: No

 ** S3Object **   <a name="rekognition-Type-AuditImage-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_AuditImage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/AuditImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/AuditImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/AuditImage) 

# Beard
<a name="API_Beard"></a>

Indicates whether or not the face has a beard, and the confidence level in the determination.

## Contents
<a name="API_Beard_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Beard-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Beard-Value"></a>
Boolean value that indicates whether the face has beard or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_Beard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Beard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Beard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Beard) 

# BlackFrame
<a name="API_BlackFrame"></a>

 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](API_StartSegmentDetection.md). 

## Contents
<a name="API_BlackFrame_Contents"></a>

 ** MaxPixelThreshold **   <a name="rekognition-Type-BlackFrame-MaxPixelThreshold"></a>
 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\$1black\$1pixel\$1value = minimum\$1luminance \$1 MaxPixelThreshold \$1luminance\$1range.   
For example, for a full range video with BlackPixelThreshold = 0.1, max\$1black\$1pixel\$1value is 0 \$1 0.1 \$1 (255-0) = 25.5.  
The default value of MaxPixelThreshold is 0.2, which maps to a max\$1black\$1pixel\$1value of 51 for a full range video. You can lower this threshold to be more strict on black levels.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** MinCoveragePercentage **   <a name="rekognition-Type-BlackFrame-MinCoveragePercentage"></a>
 The minimum percentage of pixels in a frame that need to have a luminance below the max\$1black\$1pixel\$1value 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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_BlackFrame_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/BlackFrame) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/BlackFrame) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/BlackFrame) 

# BoundingBox
<a name="API_BoundingBox"></a>

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. 

**Note**  
 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. 

## Contents
<a name="API_BoundingBox_Contents"></a>

 ** Height **   <a name="rekognition-Type-BoundingBox-Height"></a>
Height of the bounding box as a ratio of the overall image height.  
Type: Float  
Required: No

 ** Left **   <a name="rekognition-Type-BoundingBox-Left"></a>
Left coordinate of the bounding box as a ratio of overall image width.  
Type: Float  
Required: No

 ** Top **   <a name="rekognition-Type-BoundingBox-Top"></a>
Top coordinate of the bounding box as a ratio of overall image height.  
Type: Float  
Required: No

 ** Width **   <a name="rekognition-Type-BoundingBox-Width"></a>
Width of the bounding box as a ratio of the overall image width.  
Type: Float  
Required: No

## See Also
<a name="API_BoundingBox_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/BoundingBox) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/BoundingBox) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/BoundingBox) 

# Celebrity
<a name="API_Celebrity"></a>

Provides information about a celebrity recognized by the [RecognizeCelebrities](API_RecognizeCelebrities.md) operation.

## Contents
<a name="API_Celebrity_Contents"></a>

 ** Face **   <a name="rekognition-Type-Celebrity-Face"></a>
Provides information about the celebrity's face, such as its location on the image.  
Type: [ComparedFace](API_ComparedFace.md) object  
Required: No

 ** Id **   <a name="rekognition-Type-Celebrity-Id"></a>
A unique identifier for the celebrity.   
Type: String  
Pattern: `[0-9A-Za-z]*`   
Required: No

 ** KnownGender **   <a name="rekognition-Type-Celebrity-KnownGender"></a>
The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.  
Type: [KnownGender](API_KnownGender.md) object  
Required: No

 ** MatchConfidence **   <a name="rekognition-Type-Celebrity-MatchConfidence"></a>
The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Name **   <a name="rekognition-Type-Celebrity-Name"></a>
The name of the celebrity.  
Type: String  
Required: No

 ** Urls **   <a name="rekognition-Type-Celebrity-Urls"></a>
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 255 items.  
Required: No

## See Also
<a name="API_Celebrity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Celebrity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Celebrity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Celebrity) 

# CelebrityDetail
<a name="API_CelebrityDetail"></a>

Information about a recognized celebrity.

## Contents
<a name="API_CelebrityDetail_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-CelebrityDetail-BoundingBox"></a>
Bounding box around the body of a celebrity.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-CelebrityDetail-Confidence"></a>
The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Face **   <a name="rekognition-Type-CelebrityDetail-Face"></a>
Face details for the recognized celebrity.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

 ** Id **   <a name="rekognition-Type-CelebrityDetail-Id"></a>
The unique identifier for the celebrity.   
Type: String  
Pattern: `[0-9A-Za-z]*`   
Required: No

 ** KnownGender **   <a name="rekognition-Type-CelebrityDetail-KnownGender"></a>
Retrieves the known gender for the celebrity.  
Type: [KnownGender](API_KnownGender.md) object  
Required: No

 ** Name **   <a name="rekognition-Type-CelebrityDetail-Name"></a>
The name of the celebrity.  
Type: String  
Required: No

 ** Urls **   <a name="rekognition-Type-CelebrityDetail-Urls"></a>
An array of URLs pointing to additional celebrity information.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 255 items.  
Required: No

## See Also
<a name="API_CelebrityDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CelebrityDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CelebrityDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CelebrityDetail) 

# CelebrityRecognition
<a name="API_CelebrityRecognition"></a>

Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see [GetCelebrityRecognition](API_GetCelebrityRecognition.md).

## Contents
<a name="API_CelebrityRecognition_Contents"></a>

 ** Celebrity **   <a name="rekognition-Type-CelebrityRecognition-Celebrity"></a>
Information about a recognized celebrity.  
Type: [CelebrityDetail](API_CelebrityDetail.md) object  
Required: No

 ** Timestamp **   <a name="rekognition-Type-CelebrityRecognition-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_CelebrityRecognition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CelebrityRecognition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CelebrityRecognition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CelebrityRecognition) 

# Challenge
<a name="API_Challenge"></a>

Describes the type and version of the challenge being used for the Face Liveness session.

## Contents
<a name="API_Challenge_Contents"></a>

 ** Type **   <a name="rekognition-Type-Challenge-Type"></a>
The type of the challenge being used for the Face Liveness session.  
Type: String  
Valid Values: `FaceMovementAndLightChallenge | FaceMovementChallenge`   
Required: Yes

 ** Version **   <a name="rekognition-Type-Challenge-Version"></a>
The version of the challenge being used for the Face Liveness session.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 11.  
Pattern: `^(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})$`   
Required: Yes

## See Also
<a name="API_Challenge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Challenge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Challenge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Challenge) 

# ChallengePreference
<a name="API_ChallengePreference"></a>

An ordered list of preferred challenge type and versions.

## Contents
<a name="API_ChallengePreference_Contents"></a>

 ** Type **   <a name="rekognition-Type-ChallengePreference-Type"></a>
The types of challenges that have been selected for the Face Liveness session.  
Type: String  
Valid Values: `FaceMovementAndLightChallenge | FaceMovementChallenge`   
Required: Yes

 ** Versions **   <a name="rekognition-Type-ChallengePreference-Versions"></a>
The version of the challenges that have been selected for the Face Liveness session.  
Type: [Versions](API_Versions.md) object  
Required: No

## See Also
<a name="API_ChallengePreference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ChallengePreference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ChallengePreference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ChallengePreference) 

# ComparedFace
<a name="API_ComparedFace"></a>

Provides face metadata for target image faces that are analyzed by `CompareFaces` and `RecognizeCelebrities`.

## Contents
<a name="API_ComparedFace_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-ComparedFace-BoundingBox"></a>
Bounding box of the face.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-ComparedFace-Confidence"></a>
Level of confidence that what the bounding box contains is a face.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Emotions **   <a name="rekognition-Type-ComparedFace-Emotions"></a>
 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".   
Type: Array of [Emotion](API_Emotion.md) objects  
Required: No

 ** Landmarks **   <a name="rekognition-Type-ComparedFace-Landmarks"></a>
An array of facial landmarks.  
Type: Array of [Landmark](API_Landmark.md) objects  
Required: No

 ** Pose **   <a name="rekognition-Type-ComparedFace-Pose"></a>
Indicates the pose of the face as determined by its pitch, roll, and yaw.  
Type: [Pose](API_Pose.md) object  
Required: No

 ** Quality **   <a name="rekognition-Type-ComparedFace-Quality"></a>
Identifies face image brightness and sharpness.   
Type: [ImageQuality](API_ImageQuality.md) object  
Required: No

 ** Smile **   <a name="rekognition-Type-ComparedFace-Smile"></a>
 Indicates whether or not the face is smiling, and the confidence level in the determination.   
Type: [Smile](API_Smile.md) object  
Required: No

## See Also
<a name="API_ComparedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ComparedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ComparedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ComparedFace) 

# ComparedSourceImageFace
<a name="API_ComparedSourceImageFace"></a>

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. 

## Contents
<a name="API_ComparedSourceImageFace_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-ComparedSourceImageFace-BoundingBox"></a>
Bounding box of the face.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-ComparedSourceImageFace-Confidence"></a>
Confidence level that the selected bounding box contains a face.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_ComparedSourceImageFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ComparedSourceImageFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ComparedSourceImageFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ComparedSourceImageFace) 

# CompareFacesMatch
<a name="API_CompareFacesMatch"></a>

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.

## Contents
<a name="API_CompareFacesMatch_Contents"></a>

 ** Face **   <a name="rekognition-Type-CompareFacesMatch-Face"></a>
Provides face metadata (bounding box and confidence that the bounding box actually contains a face).  
Type: [ComparedFace](API_ComparedFace.md) object  
Required: No

 ** Similarity **   <a name="rekognition-Type-CompareFacesMatch-Similarity"></a>
Level of confidence that the faces match.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_CompareFacesMatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CompareFacesMatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CompareFacesMatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CompareFacesMatch) 

# ConnectedHomeSettings
<a name="API_ConnectedHomeSettings"></a>

 Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for [CreateStreamProcessor](API_CreateStreamProcessor.md). 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. 

## Contents
<a name="API_ConnectedHomeSettings_Contents"></a>

 ** Labels **   <a name="rekognition-Type-ConnectedHomeSettings-Labels"></a>
 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".   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 128 items.  
Required: Yes

 ** MinConfidence **   <a name="rekognition-Type-ConnectedHomeSettings-MinConfidence"></a>
 The minimum confidence required to label an object in the video.   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_ConnectedHomeSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ConnectedHomeSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ConnectedHomeSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ConnectedHomeSettings) 

# ConnectedHomeSettingsForUpdate
<a name="API_ConnectedHomeSettingsForUpdate"></a>

 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. 

## Contents
<a name="API_ConnectedHomeSettingsForUpdate_Contents"></a>

 ** Labels **   <a name="rekognition-Type-ConnectedHomeSettingsForUpdate-Labels"></a>
 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".   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 128 items.  
Required: No

 ** MinConfidence **   <a name="rekognition-Type-ConnectedHomeSettingsForUpdate-MinConfidence"></a>
 The minimum confidence required to label an object in the video.   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_ConnectedHomeSettingsForUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ConnectedHomeSettingsForUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ConnectedHomeSettingsForUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ConnectedHomeSettingsForUpdate) 

# ContentModerationDetection
<a name="API_ContentModerationDetection"></a>

Information about an inappropriate, unwanted, or offensive content label detection in a stored video.

## Contents
<a name="API_ContentModerationDetection_Contents"></a>

 ** ContentTypes **   <a name="rekognition-Type-ContentModerationDetection-ContentTypes"></a>
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.  
Type: Array of [ContentType](API_ContentType.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** DurationMillis **   <a name="rekognition-Type-ContentModerationDetection-DurationMillis"></a>
 The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** EndTimestampMillis **   <a name="rekognition-Type-ContentModerationDetection-EndTimestampMillis"></a>
 The time in milliseconds defining the end of the timeline segment containing a continuously detected moderation label.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** ModerationLabel **   <a name="rekognition-Type-ContentModerationDetection-ModerationLabel"></a>
The content moderation label detected by in the stored video.  
Type: [ModerationLabel](API_ModerationLabel.md) object  
Required: No

 ** StartTimestampMillis **   <a name="rekognition-Type-ContentModerationDetection-StartTimestampMillis"></a>
The time in milliseconds defining the start of the timeline segment containing a continuously detected moderation label.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** Timestamp **   <a name="rekognition-Type-ContentModerationDetection-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_ContentModerationDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ContentModerationDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ContentModerationDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ContentModerationDetection) 

# ContentType
<a name="API_ContentType"></a>

Contains information regarding the confidence and name of a detected content type.

## Contents
<a name="API_ContentType_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-ContentType-Confidence"></a>
The confidence level of the label given  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Name **   <a name="rekognition-Type-ContentType-Name"></a>
The name of the label  
Type: String  
Required: No

## See Also
<a name="API_ContentType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ContentType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ContentType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ContentType) 

# CoversBodyPart
<a name="API_CoversBodyPart"></a>

Information about an item of Personal Protective Equipment covering a corresponding body part. For more information, see [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md).

## Contents
<a name="API_CoversBodyPart_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-CoversBodyPart-Confidence"></a>
The confidence that Amazon Rekognition has in the value of `Value`.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-CoversBodyPart-Value"></a>
True if the PPE covers the corresponding body part, otherwise false.  
Type: Boolean  
Required: No

## See Also
<a name="API_CoversBodyPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CoversBodyPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CoversBodyPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CoversBodyPart) 

# CreateFaceLivenessSessionRequestSettings
<a name="API_CreateFaceLivenessSessionRequestSettings"></a>

A session settings object. It contains settings for the operation to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.

## Contents
<a name="API_CreateFaceLivenessSessionRequestSettings_Contents"></a>

 ** AuditImagesLimit **   <a name="rekognition-Type-CreateFaceLivenessSessionRequestSettings-AuditImagesLimit"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 4.  
Required: No

 ** ChallengePreferences **   <a name="rekognition-Type-CreateFaceLivenessSessionRequestSettings-ChallengePreferences"></a>
Indicates preferred challenge types and versions for the Face Liveness session to be created.  
Type: Array of [ChallengePreference](API_ChallengePreference.md) objects  
Required: No

 ** OutputConfig **   <a name="rekognition-Type-CreateFaceLivenessSessionRequestSettings-OutputConfig"></a>
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.  
Type: [LivenessOutputConfig](API_LivenessOutputConfig.md) object  
Required: No

## See Also
<a name="API_CreateFaceLivenessSessionRequestSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CreateFaceLivenessSessionRequestSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CreateFaceLivenessSessionRequestSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CreateFaceLivenessSessionRequestSettings) 

# CustomizationFeatureConfig
<a name="API_CustomizationFeatureConfig"></a>

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.

## Contents
<a name="API_CustomizationFeatureConfig_Contents"></a>

 ** ContentModeration **   <a name="rekognition-Type-CustomizationFeatureConfig-ContentModeration"></a>
Configuration options for Custom Moderation training.  
Type: [CustomizationFeatureContentModerationConfig](API_CustomizationFeatureContentModerationConfig.md) object  
Required: No

## See Also
<a name="API_CustomizationFeatureConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CustomizationFeatureConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CustomizationFeatureConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CustomizationFeatureConfig) 

# CustomizationFeatureContentModerationConfig
<a name="API_CustomizationFeatureContentModerationConfig"></a>

Configuration options for Content Moderation training.

## Contents
<a name="API_CustomizationFeatureContentModerationConfig_Contents"></a>

 ** ConfidenceThreshold **   <a name="rekognition-Type-CustomizationFeatureContentModerationConfig-ConfidenceThreshold"></a>
The confidence level you plan to use to identify if unsafe content is present during inference.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_CustomizationFeatureContentModerationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CustomizationFeatureContentModerationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CustomizationFeatureContentModerationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CustomizationFeatureContentModerationConfig) 

# CustomLabel
<a name="API_CustomLabel"></a>

A custom label detected in an image by a call to [DetectCustomLabels](API_DetectCustomLabels.md).

## Contents
<a name="API_CustomLabel_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-CustomLabel-Confidence"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Geometry **   <a name="rekognition-Type-CustomLabel-Geometry"></a>
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.  
Type: [Geometry](API_Geometry.md) object  
Required: No

 ** Name **   <a name="rekognition-Type-CustomLabel-Name"></a>
The name of the custom label.  
Type: String  
Required: No

## See Also
<a name="API_CustomLabel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/CustomLabel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/CustomLabel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/CustomLabel) 

# DatasetChanges
<a name="API_DatasetChanges"></a>

 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. 

## Contents
<a name="API_DatasetChanges_Contents"></a>

 ** GroundTruth **   <a name="rekognition-Type-DatasetChanges-GroundTruth"></a>
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](API_UpdateDatasetEntries.md). 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](https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-create-manifest-file-classification.html) and [Object localization in manifest files](https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-create-manifest-file-object-detection.html).  
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 5242880.  
Required: Yes

## See Also
<a name="API_DatasetChanges_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetChanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetChanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetChanges) 

# DatasetDescription
<a name="API_DatasetDescription"></a>

 A description for a dataset. For more information, see [DescribeDataset](API_DescribeDataset.md).

The status fields `Status`, `StatusMessage`, and `StatusMessageCode` reflect the last operation on the dataset. 

## Contents
<a name="API_DatasetDescription_Contents"></a>

 ** CreationTimestamp **   <a name="rekognition-Type-DatasetDescription-CreationTimestamp"></a>
 The Unix timestamp for the time and date that the dataset was created.   
Type: Timestamp  
Required: No

 ** DatasetStats **   <a name="rekognition-Type-DatasetDescription-DatasetStats"></a>
 The status message code for the dataset.   
Type: [DatasetStats](API_DatasetStats.md) object  
Required: No

 ** LastUpdatedTimestamp **   <a name="rekognition-Type-DatasetDescription-LastUpdatedTimestamp"></a>
 The Unix timestamp for the date and time that the dataset was last updated.   
Type: Timestamp  
Required: No

 ** Status **   <a name="rekognition-Type-DatasetDescription-Status"></a>
 The status of the dataset.   
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED | DELETE_IN_PROGRESS`   
Required: No

 ** StatusMessage **   <a name="rekognition-Type-DatasetDescription-StatusMessage"></a>
 The status message for the dataset.   
Type: String  
Required: No

 ** StatusMessageCode **   <a name="rekognition-Type-DatasetDescription-StatusMessageCode"></a>
 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.   
Type: String  
Valid Values: `SUCCESS | SERVICE_ERROR | CLIENT_ERROR`   
Required: No

## See Also
<a name="API_DatasetDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetDescription) 

# DatasetLabelDescription
<a name="API_DatasetLabelDescription"></a>

 Describes a dataset label. For more information, see [ListDatasetLabels](API_ListDatasetLabels.md). 

## Contents
<a name="API_DatasetLabelDescription_Contents"></a>

 ** LabelName **   <a name="rekognition-Type-DatasetLabelDescription-LabelName"></a>
 The name of the label.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.{1,}`   
Required: No

 ** LabelStats **   <a name="rekognition-Type-DatasetLabelDescription-LabelStats"></a>
 Statistics about the label.   
Type: [DatasetLabelStats](API_DatasetLabelStats.md) object  
Required: No

## See Also
<a name="API_DatasetLabelDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetLabelDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetLabelDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetLabelDescription) 

# DatasetLabelStats
<a name="API_DatasetLabelStats"></a>

 Statistics about a label used in a dataset. For more information, see [DatasetLabelDescription](API_DatasetLabelDescription.md). 

## Contents
<a name="API_DatasetLabelStats_Contents"></a>

 ** BoundingBoxCount **   <a name="rekognition-Type-DatasetLabelStats-BoundingBoxCount"></a>
 The total number of images that have the label assigned to a bounding box.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** EntryCount **   <a name="rekognition-Type-DatasetLabelStats-EntryCount"></a>
 The total number of images that use the label.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_DatasetLabelStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetLabelStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetLabelStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetLabelStats) 

# DatasetMetadata
<a name="API_DatasetMetadata"></a>

 Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see [ProjectDescription](API_ProjectDescription.md). 

## Contents
<a name="API_DatasetMetadata_Contents"></a>

 ** CreationTimestamp **   <a name="rekognition-Type-DatasetMetadata-CreationTimestamp"></a>
 The Unix timestamp for the date and time that the dataset was created.   
Type: Timestamp  
Required: No

 ** DatasetArn **   <a name="rekognition-Type-DatasetMetadata-DatasetArn"></a>
 The Amazon Resource Name (ARN) for the dataset.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)`   
Required: No

 ** DatasetType **   <a name="rekognition-Type-DatasetMetadata-DatasetType"></a>
 The type of the dataset.   
Type: String  
Valid Values: `TRAIN | TEST`   
Required: No

 ** Status **   <a name="rekognition-Type-DatasetMetadata-Status"></a>
 The status for the dataset.   
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED | DELETE_IN_PROGRESS`   
Required: No

 ** StatusMessage **   <a name="rekognition-Type-DatasetMetadata-StatusMessage"></a>
 The status message for the dataset.   
Type: String  
Required: No

 ** StatusMessageCode **   <a name="rekognition-Type-DatasetMetadata-StatusMessageCode"></a>
 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.   
Type: String  
Valid Values: `SUCCESS | SERVICE_ERROR | CLIENT_ERROR`   
Required: No

## See Also
<a name="API_DatasetMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetMetadata) 

# DatasetSource
<a name="API_DatasetSource"></a>

 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](API_CreateDataset.md).

## Contents
<a name="API_DatasetSource_Contents"></a>

 ** DatasetArn **   <a name="rekognition-Type-DatasetSource-DatasetArn"></a>
 The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)`   
Required: No

 ** GroundTruthManifest **   <a name="rekognition-Type-DatasetSource-GroundTruthManifest"></a>
The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.   
Type: [GroundTruthManifest](API_GroundTruthManifest.md) object  
Required: No

## See Also
<a name="API_DatasetSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetSource) 

# DatasetStats
<a name="API_DatasetStats"></a>

 Provides statistics about a dataset. For more information, see [DescribeDataset](API_DescribeDataset.md). 

## Contents
<a name="API_DatasetStats_Contents"></a>

 ** ErrorEntries **   <a name="rekognition-Type-DatasetStats-ErrorEntries"></a>
 The total number of entries that contain at least one error.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** LabeledEntries **   <a name="rekognition-Type-DatasetStats-LabeledEntries"></a>
 The total number of images in the dataset that have labels.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** TotalEntries **   <a name="rekognition-Type-DatasetStats-TotalEntries"></a>
 The total number of images in the dataset.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** TotalLabels **   <a name="rekognition-Type-DatasetStats-TotalLabels"></a>
 The total number of labels declared in the dataset.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_DatasetStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DatasetStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DatasetStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DatasetStats) 

# DetectionFilter
<a name="API_DetectionFilter"></a>

A set of parameters that allow you to filter out certain results from your returned results.

## Contents
<a name="API_DetectionFilter_Contents"></a>

 ** MinBoundingBoxHeight **   <a name="rekognition-Type-DetectionFilter-MinBoundingBoxHeight"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** MinBoundingBoxWidth **   <a name="rekognition-Type-DetectionFilter-MinBoundingBoxWidth"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 1.  
Required: No

 ** MinConfidence **   <a name="rekognition-Type-DetectionFilter-MinConfidence"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_DetectionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectionFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectionFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectionFilter) 

# DetectLabelsImageBackground
<a name="API_DetectLabelsImageBackground"></a>

The background of the image with regard to image quality and dominant colors.

## Contents
<a name="API_DetectLabelsImageBackground_Contents"></a>

 ** DominantColors **   <a name="rekognition-Type-DetectLabelsImageBackground-DominantColors"></a>
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).  
Type: Array of [DominantColor](API_DominantColor.md) objects  
Required: No

 ** Quality **   <a name="rekognition-Type-DetectLabelsImageBackground-Quality"></a>
The quality of the image background as defined by brightness and sharpness.  
Type: [DetectLabelsImageQuality](API_DetectLabelsImageQuality.md) object  
Required: No

## See Also
<a name="API_DetectLabelsImageBackground_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsImageBackground) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsImageBackground) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsImageBackground) 

# DetectLabelsImageForeground
<a name="API_DetectLabelsImageForeground"></a>

The foreground of the image with regard to image quality and dominant colors.

## Contents
<a name="API_DetectLabelsImageForeground_Contents"></a>

 ** DominantColors **   <a name="rekognition-Type-DetectLabelsImageForeground-DominantColors"></a>
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).  
Type: Array of [DominantColor](API_DominantColor.md) objects  
Required: No

 ** Quality **   <a name="rekognition-Type-DetectLabelsImageForeground-Quality"></a>
The quality of the image foreground as defined by brightness and sharpness.  
Type: [DetectLabelsImageQuality](API_DetectLabelsImageQuality.md) object  
Required: No

## See Also
<a name="API_DetectLabelsImageForeground_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsImageForeground) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsImageForeground) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsImageForeground) 

# DetectLabelsImageProperties
<a name="API_DetectLabelsImageProperties"></a>

Information about the quality and dominant colors of an input image. Quality and color information is returned for the entire image, foreground, and background.

## Contents
<a name="API_DetectLabelsImageProperties_Contents"></a>

 ** Background **   <a name="rekognition-Type-DetectLabelsImageProperties-Background"></a>
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.  
Type: [DetectLabelsImageBackground](API_DetectLabelsImageBackground.md) object  
Required: No

 ** DominantColors **   <a name="rekognition-Type-DetectLabelsImageProperties-DominantColors"></a>
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).  
Type: Array of [DominantColor](API_DominantColor.md) objects  
Required: No

 ** Foreground **   <a name="rekognition-Type-DetectLabelsImageProperties-Foreground"></a>
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.  
Type: [DetectLabelsImageForeground](API_DetectLabelsImageForeground.md) object  
Required: No

 ** Quality **   <a name="rekognition-Type-DetectLabelsImageProperties-Quality"></a>
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.  
Type: [DetectLabelsImageQuality](API_DetectLabelsImageQuality.md) object  
Required: No

## See Also
<a name="API_DetectLabelsImageProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsImageProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsImageProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsImageProperties) 

# DetectLabelsImagePropertiesSettings
<a name="API_DetectLabelsImagePropertiesSettings"></a>

Settings for the IMAGE\$1PROPERTIES feature type.

## Contents
<a name="API_DetectLabelsImagePropertiesSettings_Contents"></a>

 ** MaxDominantColors **   <a name="rekognition-Type-DetectLabelsImagePropertiesSettings-MaxDominantColors"></a>
The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

## See Also
<a name="API_DetectLabelsImagePropertiesSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsImagePropertiesSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsImagePropertiesSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsImagePropertiesSettings) 

# DetectLabelsImageQuality
<a name="API_DetectLabelsImageQuality"></a>

The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.

## Contents
<a name="API_DetectLabelsImageQuality_Contents"></a>

 ** Brightness **   <a name="rekognition-Type-DetectLabelsImageQuality-Brightness"></a>
The brightness of an image provided for label detection.  
Type: Float  
Required: No

 ** Contrast **   <a name="rekognition-Type-DetectLabelsImageQuality-Contrast"></a>
The contrast of an image provided for label detection.  
Type: Float  
Required: No

 ** Sharpness **   <a name="rekognition-Type-DetectLabelsImageQuality-Sharpness"></a>
The sharpness of an image provided for label detection.  
Type: Float  
Required: No

## See Also
<a name="API_DetectLabelsImageQuality_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsImageQuality) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsImageQuality) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsImageQuality) 

# DetectLabelsSettings
<a name="API_DetectLabelsSettings"></a>

Settings for the DetectLabels request. Settings can include filters for both GENERAL\$1LABELS and IMAGE\$1PROPERTIES. GENERAL\$1LABELS filters can be inclusive or exclusive and applied to individual labels or label categories. IMAGE\$1PROPERTIES filters allow specification of a maximum number of dominant colors.

## Contents
<a name="API_DetectLabelsSettings_Contents"></a>

 ** GeneralLabels **   <a name="rekognition-Type-DetectLabelsSettings-GeneralLabels"></a>
Contains the specified filters for GENERAL\$1LABELS.  
Type: [GeneralLabelsSettings](API_GeneralLabelsSettings.md) object  
Required: No

 ** ImageProperties **   <a name="rekognition-Type-DetectLabelsSettings-ImageProperties"></a>
Contains the chosen number of maximum dominant colors in an image.  
Type: [DetectLabelsImagePropertiesSettings](API_DetectLabelsImagePropertiesSettings.md) object  
Required: No

## See Also
<a name="API_DetectLabelsSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectLabelsSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectLabelsSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectLabelsSettings) 

# DetectTextFilters
<a name="API_DetectTextFilters"></a>

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. 

## Contents
<a name="API_DetectTextFilters_Contents"></a>

 ** RegionsOfInterest **   <a name="rekognition-Type-DetectTextFilters-RegionsOfInterest"></a>
 A Filter focusing on a certain area of the image. Uses a `BoundingBox` object to set the region of the image.  
Type: Array of [RegionOfInterest](API_RegionOfInterest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** WordFilter **   <a name="rekognition-Type-DetectTextFilters-WordFilter"></a>
A set of parameters that allow you to filter out certain results from your returned results.  
Type: [DetectionFilter](API_DetectionFilter.md) object  
Required: No

## See Also
<a name="API_DetectTextFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DetectTextFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DetectTextFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DetectTextFilters) 

# DisassociatedFace
<a name="API_DisassociatedFace"></a>

Provides face metadata for the faces that are disassociated from a specific UserID.

## Contents
<a name="API_DisassociatedFace_Contents"></a>

 ** FaceId **   <a name="rekognition-Type-DisassociatedFace-FaceId"></a>
Unique identifier assigned to the face.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_DisassociatedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DisassociatedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DisassociatedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DisassociatedFace) 

# DistributeDataset
<a name="API_DistributeDataset"></a>

 A training dataset or a test dataset used in a dataset distribution operation. For more information, see [DistributeDatasetEntries](API_DistributeDatasetEntries.md). 

## Contents
<a name="API_DistributeDataset_Contents"></a>

 ** Arn **   <a name="rekognition-Type-DistributeDataset-Arn"></a>
The Amazon Resource Name (ARN) of the dataset that you want to use.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)`   
Required: Yes

## See Also
<a name="API_DistributeDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DistributeDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DistributeDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DistributeDataset) 

# DominantColor
<a name="API_DominantColor"></a>

A description of the dominant colors in an image.

## Contents
<a name="API_DominantColor_Contents"></a>

 ** Blue **   <a name="rekognition-Type-DominantColor-Blue"></a>
The Blue RGB value for a dominant color.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** CSSColor **   <a name="rekognition-Type-DominantColor-CSSColor"></a>
The CSS color name of a dominant color.  
Type: String  
Required: No

 ** Green **   <a name="rekognition-Type-DominantColor-Green"></a>
The Green RGB value for a dominant color.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** HexCode **   <a name="rekognition-Type-DominantColor-HexCode"></a>
The Hex code equivalent of the RGB values for a dominant color.  
Type: String  
Required: No

 ** PixelPercent **   <a name="rekognition-Type-DominantColor-PixelPercent"></a>
The percentage of image pixels that have a given dominant color.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Red **   <a name="rekognition-Type-DominantColor-Red"></a>
The Red RGB value for a dominant color.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** SimplifiedColor **   <a name="rekognition-Type-DominantColor-SimplifiedColor"></a>
One of 12 simplified color names applied to a dominant color.  
Type: String  
Required: No

## See Also
<a name="API_DominantColor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/DominantColor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/DominantColor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/DominantColor) 

# Emotion
<a name="API_Emotion"></a>

The API returns a prediction of an emotion based on a person's facial expressions, along with the confidence level for the predicted emotion. 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. The API is not intended to be used, and you may not use it, in a manner that violates the EU Artificial Intelligence Act or any other applicable law.

## Contents
<a name="API_Emotion_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Emotion-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Type **   <a name="rekognition-Type-Emotion-Type"></a>
Type of emotion detected.  
Type: String  
Valid Values: `HAPPY | SAD | ANGRY | CONFUSED | DISGUSTED | SURPRISED | CALM | UNKNOWN | FEAR`   
Required: No

## See Also
<a name="API_Emotion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Emotion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Emotion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Emotion) 

# EquipmentDetection
<a name="API_EquipmentDetection"></a>

Information about an item of Personal Protective Equipment (PPE) detected by [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md). For more information, see [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md).

## Contents
<a name="API_EquipmentDetection_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-EquipmentDetection-BoundingBox"></a>
A bounding box surrounding the item of detected PPE.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-EquipmentDetection-Confidence"></a>
The confidence that Amazon Rekognition has that the bounding box (`BoundingBox`) contains an item of PPE.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** CoversBodyPart **   <a name="rekognition-Type-EquipmentDetection-CoversBodyPart"></a>
Information about the body part covered by the detected PPE.  
Type: [CoversBodyPart](API_CoversBodyPart.md) object  
Required: No

 ** Type **   <a name="rekognition-Type-EquipmentDetection-Type"></a>
The type of detected PPE.  
Type: String  
Valid Values: `FACE_COVER | HAND_COVER | HEAD_COVER`   
Required: No

## See Also
<a name="API_EquipmentDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/EquipmentDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/EquipmentDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/EquipmentDetection) 

# EvaluationResult
<a name="API_EvaluationResult"></a>

The evaluation results for the training of a model.

## Contents
<a name="API_EvaluationResult_Contents"></a>

 ** F1Score **   <a name="rekognition-Type-EvaluationResult-F1Score"></a>
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.   
Type: Float  
Required: No

 ** Summary **   <a name="rekognition-Type-EvaluationResult-Summary"></a>
The S3 bucket that contains the training summary.  
Type: [Summary](API_Summary.md) object  
Required: No

## See Also
<a name="API_EvaluationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/EvaluationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/EvaluationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/EvaluationResult) 

# EyeDirection
<a name="API_EyeDirection"></a>

Indicates the direction the eyes are gazing in (independent of the head pose) as determined by its pitch and yaw. 

## Contents
<a name="API_EyeDirection_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-EyeDirection-Confidence"></a>
The confidence that the service has in its predicted eye direction.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Pitch **   <a name="rekognition-Type-EyeDirection-Pitch"></a>
Value representing eye direction on the pitch axis.  
Type: Float  
Valid Range: Minimum value of -180. Maximum value of 180.  
Required: No

 ** Yaw **   <a name="rekognition-Type-EyeDirection-Yaw"></a>
Value representing eye direction on the yaw axis.  
Type: Float  
Valid Range: Minimum value of -180. Maximum value of 180.  
Required: No

## See Also
<a name="API_EyeDirection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/EyeDirection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/EyeDirection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/EyeDirection) 

# Eyeglasses
<a name="API_Eyeglasses"></a>

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

## Contents
<a name="API_Eyeglasses_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Eyeglasses-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Eyeglasses-Value"></a>
Boolean value that indicates whether the face is wearing eye glasses or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_Eyeglasses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Eyeglasses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Eyeglasses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Eyeglasses) 

# EyeOpen
<a name="API_EyeOpen"></a>

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

## Contents
<a name="API_EyeOpen_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-EyeOpen-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-EyeOpen-Value"></a>
Boolean value that indicates whether the eyes on the face are open.  
Type: Boolean  
Required: No

## See Also
<a name="API_EyeOpen_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/EyeOpen) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/EyeOpen) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/EyeOpen) 

# Face
<a name="API_Face"></a>

Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned. 

## Contents
<a name="API_Face_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-Face-BoundingBox"></a>
Bounding box of the face.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-Face-Confidence"></a>
Confidence level that the bounding box contains a face (and not a different object such as a tree).  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** ExternalImageId **   <a name="rekognition-Type-Face-ExternalImageId"></a>
Identifier that you assign to all the faces in the input image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** FaceId **   <a name="rekognition-Type-Face-FaceId"></a>
Unique identifier that Amazon Rekognition assigns to the face.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** ImageId **   <a name="rekognition-Type-Face-ImageId"></a>
Unique identifier that Amazon Rekognition assigns to the input image.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** IndexFacesModelVersion **   <a name="rekognition-Type-Face-IndexFacesModelVersion"></a>
 The version of the face detect and storage model that was used when indexing the face vector.   
Type: String  
Pattern: `[0-9\.]+`   
Required: No

 ** UserId **   <a name="rekognition-Type-Face-UserId"></a>
Unique identifier assigned to the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

## See Also
<a name="API_Face_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Face) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Face) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Face) 

# FaceDetail
<a name="API_FaceDetail"></a>

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](API_GetFaceDetection.md) 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](API_StartFaceDetection.md). 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](API_DetectFaces.md) and [IndexFaces](API_IndexFaces.md) 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.

## Contents
<a name="API_FaceDetail_Contents"></a>

 ** AgeRange **   <a name="rekognition-Type-FaceDetail-AgeRange"></a>
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.  
Type: [AgeRange](API_AgeRange.md) object  
Required: No

 ** Beard **   <a name="rekognition-Type-FaceDetail-Beard"></a>
Indicates whether or not the face has a beard, and the confidence level in the determination.  
Type: [Beard](API_Beard.md) object  
Required: No

 ** BoundingBox **   <a name="rekognition-Type-FaceDetail-BoundingBox"></a>
Bounding box of the face. Default attribute.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-FaceDetail-Confidence"></a>
Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Emotions **   <a name="rekognition-Type-FaceDetail-Emotions"></a>
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.  
Type: Array of [Emotion](API_Emotion.md) objects  
Required: No

 ** EyeDirection **   <a name="rekognition-Type-FaceDetail-EyeDirection"></a>
Indicates the direction the eyes are gazing in, as defined by pitch and yaw.  
Type: [EyeDirection](API_EyeDirection.md) object  
Required: No

 ** Eyeglasses **   <a name="rekognition-Type-FaceDetail-Eyeglasses"></a>
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.  
Type: [Eyeglasses](API_Eyeglasses.md) object  
Required: No

 ** EyesOpen **   <a name="rekognition-Type-FaceDetail-EyesOpen"></a>
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.  
Type: [EyeOpen](API_EyeOpen.md) object  
Required: No

 ** FaceOccluded **   <a name="rekognition-Type-FaceDetail-FaceOccluded"></a>
 `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.   
Type: [FaceOccluded](API_FaceOccluded.md) object  
Required: No

 ** Gender **   <a name="rekognition-Type-FaceDetail-Gender"></a>
The predicted gender of a detected face.   
Type: [Gender](API_Gender.md) object  
Required: No

 ** Landmarks **   <a name="rekognition-Type-FaceDetail-Landmarks"></a>
Indicates the location of landmarks on the face. Default attribute.  
Type: Array of [Landmark](API_Landmark.md) objects  
Required: No

 ** MouthOpen **   <a name="rekognition-Type-FaceDetail-MouthOpen"></a>
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.  
Type: [MouthOpen](API_MouthOpen.md) object  
Required: No

 ** Mustache **   <a name="rekognition-Type-FaceDetail-Mustache"></a>
Indicates whether or not the face has a mustache, and the confidence level in the determination.  
Type: [Mustache](API_Mustache.md) object  
Required: No

 ** Pose **   <a name="rekognition-Type-FaceDetail-Pose"></a>
Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.  
Type: [Pose](API_Pose.md) object  
Required: No

 ** Quality **   <a name="rekognition-Type-FaceDetail-Quality"></a>
Identifies image brightness and sharpness. Default attribute.  
Type: [ImageQuality](API_ImageQuality.md) object  
Required: No

 ** Smile **   <a name="rekognition-Type-FaceDetail-Smile"></a>
Indicates whether or not the face is smiling, and the confidence level in the determination.  
Type: [Smile](API_Smile.md) object  
Required: No

 ** Sunglasses **   <a name="rekognition-Type-FaceDetail-Sunglasses"></a>
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.  
Type: [Sunglasses](API_Sunglasses.md) object  
Required: No

## See Also
<a name="API_FaceDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceDetail) 

# FaceDetection
<a name="API_FaceDetection"></a>

Information about a face detected in a video analysis request and the time the face was detected in the video. 

## Contents
<a name="API_FaceDetection_Contents"></a>

 ** Face **   <a name="rekognition-Type-FaceDetection-Face"></a>
The face properties for the detected face.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

 ** Timestamp **   <a name="rekognition-Type-FaceDetection-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_FaceDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceDetection) 

# FaceMatch
<a name="API_FaceMatch"></a>

Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

## Contents
<a name="API_FaceMatch_Contents"></a>

 ** Face **   <a name="rekognition-Type-FaceMatch-Face"></a>
Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.  
Type: [Face](API_Face.md) object  
Required: No

 ** Similarity **   <a name="rekognition-Type-FaceMatch-Similarity"></a>
Confidence in the match of this face with the input face.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_FaceMatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceMatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceMatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceMatch) 

# FaceOccluded
<a name="API_FaceOccluded"></a>

 `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.

## Contents
<a name="API_FaceOccluded_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-FaceOccluded-Confidence"></a>
The confidence that the service has detected the presence of a face occlusion.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-FaceOccluded-Value"></a>
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.  
Type: Boolean  
Required: No

## See Also
<a name="API_FaceOccluded_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceOccluded) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceOccluded) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceOccluded) 

# FaceRecord
<a name="API_FaceRecord"></a>

Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren't stored in the database.

## Contents
<a name="API_FaceRecord_Contents"></a>

 ** Face **   <a name="rekognition-Type-FaceRecord-Face"></a>
Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.   
Type: [Face](API_Face.md) object  
Required: No

 ** FaceDetail **   <a name="rekognition-Type-FaceRecord-FaceDetail"></a>
Structure containing attributes of the face that the algorithm detected.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

## See Also
<a name="API_FaceRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceRecord) 

# FaceSearchSettings
<a name="API_FaceSearchSettings"></a>

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](API_CreateStreamProcessor.md).

## Contents
<a name="API_FaceSearchSettings_Contents"></a>

 ** CollectionId **   <a name="rekognition-Type-FaceSearchSettings-CollectionId"></a>
The ID of a collection that contains faces that you want to search for.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_.\-]+`   
Required: No

 ** FaceMatchThreshold **   <a name="rekognition-Type-FaceSearchSettings-FaceMatchThreshold"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

## See Also
<a name="API_FaceSearchSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/FaceSearchSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/FaceSearchSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/FaceSearchSettings) 

# Gender
<a name="API_Gender"></a>

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.

## Contents
<a name="API_Gender_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Gender-Confidence"></a>
Level of confidence in the prediction.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Gender-Value"></a>
The predicted gender of the face.  
Type: String  
Valid Values: `Male | Female`   
Required: No

## See Also
<a name="API_Gender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Gender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Gender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Gender) 

# GeneralLabelsSettings
<a name="API_GeneralLabelsSettings"></a>

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](https://docs.aws.amazon.com/rekognition/latest/dg/labels.html).

## Contents
<a name="API_GeneralLabelsSettings_Contents"></a>

 ** LabelCategoryExclusionFilters **   <a name="rekognition-Type-GeneralLabelsSettings-LabelCategoryExclusionFilters"></a>
The label categories that should be excluded from the return from DetectLabels.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Pattern: `[A-Za-z0-9àâèçñó'-_(). ]*`   
Required: No

 ** LabelCategoryInclusionFilters **   <a name="rekognition-Type-GeneralLabelsSettings-LabelCategoryInclusionFilters"></a>
The label categories that should be included in the return from DetectLabels.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Pattern: `[A-Za-z0-9àâèçñó'-_(). ]*`   
Required: No

 ** LabelExclusionFilters **   <a name="rekognition-Type-GeneralLabelsSettings-LabelExclusionFilters"></a>
The labels that should be excluded from the return from DetectLabels.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Pattern: `[A-Za-z0-9àâèçñó'-_(). ]*`   
Required: No

 ** LabelInclusionFilters **   <a name="rekognition-Type-GeneralLabelsSettings-LabelInclusionFilters"></a>
The labels that should be included in the return from DetectLabels.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Pattern: `[A-Za-z0-9àâèçñó'-_(). ]*`   
Required: No

## See Also
<a name="API_GeneralLabelsSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/GeneralLabelsSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/GeneralLabelsSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/GeneralLabelsSettings) 

# Geometry
<a name="API_Geometry"></a>

Information about where an object ([DetectCustomLabels](API_DetectCustomLabels.md)) or text ([DetectText](API_DetectText.md)) is located on an image.

## Contents
<a name="API_Geometry_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-Geometry-BoundingBox"></a>
An axis-aligned coarse representation of the detected item's location on the image.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Polygon **   <a name="rekognition-Type-Geometry-Polygon"></a>
Within the bounding box, a fine-grained polygon around the detected item.  
Type: Array of [Point](API_Point.md) objects  
Required: No

## See Also
<a name="API_Geometry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Geometry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Geometry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Geometry) 

# GetContentModerationRequestMetadata
<a name="API_GetContentModerationRequestMetadata"></a>

Contains metadata about a content moderation request, including the SortBy and AggregateBy options.

## Contents
<a name="API_GetContentModerationRequestMetadata_Contents"></a>

 ** AggregateBy **   <a name="rekognition-Type-GetContentModerationRequestMetadata-AggregateBy"></a>
The aggregation method chosen for a GetContentModeration request.  
Type: String  
Valid Values: `TIMESTAMPS | SEGMENTS`   
Required: No

 ** SortBy **   <a name="rekognition-Type-GetContentModerationRequestMetadata-SortBy"></a>
The sorting method chosen for a GetContentModeration request.  
Type: String  
Valid Values: `NAME | TIMESTAMP`   
Required: No

## See Also
<a name="API_GetContentModerationRequestMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/GetContentModerationRequestMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/GetContentModerationRequestMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/GetContentModerationRequestMetadata) 

# GetLabelDetectionRequestMetadata
<a name="API_GetLabelDetectionRequestMetadata"></a>

Contains metadata about a label detection request, including the SortBy and AggregateBy options.

## Contents
<a name="API_GetLabelDetectionRequestMetadata_Contents"></a>

 ** AggregateBy **   <a name="rekognition-Type-GetLabelDetectionRequestMetadata-AggregateBy"></a>
The aggregation method chosen for a GetLabelDetection request.  
Type: String  
Valid Values: `TIMESTAMPS | SEGMENTS`   
Required: No

 ** SortBy **   <a name="rekognition-Type-GetLabelDetectionRequestMetadata-SortBy"></a>
The sorting method chosen for a GetLabelDetection request.  
Type: String  
Valid Values: `NAME | TIMESTAMP`   
Required: No

## See Also
<a name="API_GetLabelDetectionRequestMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/GetLabelDetectionRequestMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/GetLabelDetectionRequestMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/GetLabelDetectionRequestMetadata) 

# GroundTruthManifest
<a name="API_GroundTruthManifest"></a>

The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file. 

## Contents
<a name="API_GroundTruthManifest_Contents"></a>

 ** S3Object **   <a name="rekognition-Type-GroundTruthManifest-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_GroundTruthManifest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/GroundTruthManifest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/GroundTruthManifest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/GroundTruthManifest) 

# HumanLoopActivationOutput
<a name="API_HumanLoopActivationOutput"></a>

Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.

## Contents
<a name="API_HumanLoopActivationOutput_Contents"></a>

 ** HumanLoopActivationConditionsEvaluationResults **   <a name="rekognition-Type-HumanLoopActivationOutput-HumanLoopActivationConditionsEvaluationResults"></a>
Shows the result of condition evaluations, including those conditions which activated a human review.  
Type: String  
Length Constraints: Maximum length of 10240.  
Required: No

 ** HumanLoopActivationReasons **   <a name="rekognition-Type-HumanLoopActivationOutput-HumanLoopActivationReasons"></a>
Shows if and why human review was needed.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Required: No

 ** HumanLoopArn **   <a name="rekognition-Type-HumanLoopActivationOutput-HumanLoopArn"></a>
The Amazon Resource Name (ARN) of the HumanLoop created.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

## See Also
<a name="API_HumanLoopActivationOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/HumanLoopActivationOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/HumanLoopActivationOutput) 

# HumanLoopConfig
<a name="API_HumanLoopConfig"></a>

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.

## Contents
<a name="API_HumanLoopConfig_Contents"></a>

 ** FlowDefinitionArn **   <a name="rekognition-Type-HumanLoopConfig-FlowDefinitionArn"></a>
The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker [CreateFlowDefinition](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html) Operation.   
Type: String  
Length Constraints: Maximum length of 256.  
Required: Yes

 ** HumanLoopName **   <a name="rekognition-Type-HumanLoopConfig-HumanLoopName"></a>
The name of the human review used for this image. This should be kept unique within a region.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `^[a-z0-9](-*[a-z0-9])*`   
Required: Yes

 ** DataAttributes **   <a name="rekognition-Type-HumanLoopConfig-DataAttributes"></a>
Sets attributes of the input data.  
Type: [HumanLoopDataAttributes](API_HumanLoopDataAttributes.md) object  
Required: No

## See Also
<a name="API_HumanLoopConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/HumanLoopConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/HumanLoopConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/HumanLoopConfig) 

# HumanLoopDataAttributes
<a name="API_HumanLoopDataAttributes"></a>

Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information.

## Contents
<a name="API_HumanLoopDataAttributes_Contents"></a>

 ** ContentClassifiers **   <a name="rekognition-Type-HumanLoopDataAttributes-ContentClassifiers"></a>
Sets whether the input image is free of personally identifiable information.  
Type: Array of strings  
Array Members: Maximum number of 256 items.  
Valid Values: `FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent`   
Required: No

## See Also
<a name="API_HumanLoopDataAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/HumanLoopDataAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/HumanLoopDataAttributes) 

# Image
<a name="API_Image"></a>

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](https://docs.aws.amazon.com/rekognition/latest/dg/images-bytes.html) .

 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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html). 

## Contents
<a name="API_Image_Contents"></a>

 ** Bytes **   <a name="rekognition-Type-Image-Bytes"></a>
Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to [DetectCustomLabels](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html) is 4MB.   
Type: Base64-encoded binary data object  
Length Constraints: Minimum length of 1. Maximum length of 5242880.  
Required: No

 ** S3Object **   <a name="rekognition-Type-Image-S3Object"></a>
Identifies an S3 object as the image source.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_Image_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Image) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Image) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Image) 

# ImageQuality
<a name="API_ImageQuality"></a>

Identifies face image brightness and sharpness. 

## Contents
<a name="API_ImageQuality_Contents"></a>

 ** Brightness **   <a name="rekognition-Type-ImageQuality-Brightness"></a>
Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.  
Type: Float  
Required: No

 ** Sharpness **   <a name="rekognition-Type-ImageQuality-Sharpness"></a>
Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.  
Type: Float  
Required: No

## See Also
<a name="API_ImageQuality_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ImageQuality) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ImageQuality) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ImageQuality) 

# Instance
<a name="API_Instance"></a>

An instance of a label returned by Amazon Rekognition Image ([DetectLabels](API_DetectLabels.md)) or by Amazon Rekognition Video ([GetLabelDetection](API_GetLabelDetection.md)).

## Contents
<a name="API_Instance_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-Instance-BoundingBox"></a>
The position of the label instance on the image.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-Instance-Confidence"></a>
The confidence that Amazon Rekognition has in the accuracy of the bounding box.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** DominantColors **   <a name="rekognition-Type-Instance-DominantColors"></a>
The dominant colors found in an individual instance of a label.  
Type: Array of [DominantColor](API_DominantColor.md) objects  
Required: No

## See Also
<a name="API_Instance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Instance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Instance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Instance) 

# KinesisDataStream
<a name="API_KinesisDataStream"></a>

The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see [CreateStreamProcessor](API_CreateStreamProcessor.md).

## Contents
<a name="API_KinesisDataStream_Contents"></a>

 ** Arn **   <a name="rekognition-Type-KinesisDataStream-Arn"></a>
ARN of the output Amazon Kinesis Data Streams stream.  
Type: String  
Pattern: `(^arn:([a-z\d-]+):kinesis:([a-z\d-]+):\d{12}:.+$)`   
Required: No

## See Also
<a name="API_KinesisDataStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/KinesisDataStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/KinesisDataStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/KinesisDataStream) 

# KinesisVideoStream
<a name="API_KinesisVideoStream"></a>

Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see [CreateStreamProcessor](API_CreateStreamProcessor.md).

## Contents
<a name="API_KinesisVideoStream_Contents"></a>

 ** Arn **   <a name="rekognition-Type-KinesisVideoStream-Arn"></a>
ARN of the Kinesis video stream stream that streams the source video.  
Type: String  
Pattern: `(^arn:([a-z\d-]+):kinesisvideo:([a-z\d-]+):\d{12}:.+$)`   
Required: No

## See Also
<a name="API_KinesisVideoStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/KinesisVideoStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/KinesisVideoStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/KinesisVideoStream) 

# KinesisVideoStreamStartSelector
<a name="API_KinesisVideoStreamStartSelector"></a>

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](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html). 

## Contents
<a name="API_KinesisVideoStreamStartSelector_Contents"></a>

 ** FragmentNumber **   <a name="rekognition-Type-KinesisVideoStreamStartSelector-FragmentNumber"></a>
 The unique identifier of the fragment. This value monotonically increases based on the ingestion order.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[0-9]+$`   
Required: No

 ** ProducerTimestamp **   <a name="rekognition-Type-KinesisVideoStreamStartSelector-ProducerTimestamp"></a>
 The timestamp from the producer corresponding to the fragment, in milliseconds, expressed in unix time format.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_KinesisVideoStreamStartSelector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/KinesisVideoStreamStartSelector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/KinesisVideoStreamStartSelector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/KinesisVideoStreamStartSelector) 

# KnownGender
<a name="API_KnownGender"></a>

The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.

## Contents
<a name="API_KnownGender_Contents"></a>

 ** Type **   <a name="rekognition-Type-KnownGender-Type"></a>
A string value of the KnownGender info about the Celebrity.  
Type: String  
Valid Values: `Male | Female | Nonbinary | Unlisted`   
Required: No

## See Also
<a name="API_KnownGender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/KnownGender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/KnownGender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/KnownGender) 

# Label
<a name="API_Label"></a>

Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.

 

## Contents
<a name="API_Label_Contents"></a>

 ** Aliases **   <a name="rekognition-Type-Label-Aliases"></a>
A list of potential aliases for a given label.  
Type: Array of [LabelAlias](API_LabelAlias.md) objects  
Required: No

 ** Categories **   <a name="rekognition-Type-Label-Categories"></a>
A list of the categories associated with a given label.  
Type: Array of [LabelCategory](API_LabelCategory.md) objects  
Required: No

 ** Confidence **   <a name="rekognition-Type-Label-Confidence"></a>
Level of confidence.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Instances **   <a name="rekognition-Type-Label-Instances"></a>
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.  
Type: Array of [Instance](API_Instance.md) objects  
Required: No

 ** Name **   <a name="rekognition-Type-Label-Name"></a>
The name (label) of the object or scene.  
Type: String  
Required: No

 ** Parents **   <a name="rekognition-Type-Label-Parents"></a>
The parent labels for a label. The response includes all ancestor labels.  
Type: Array of [Parent](API_Parent.md) objects  
Required: No

## See Also
<a name="API_Label_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Label) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Label) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Label) 

# LabelAlias
<a name="API_LabelAlias"></a>

A potential alias of for a given label.

## Contents
<a name="API_LabelAlias_Contents"></a>

 ** Name **   <a name="rekognition-Type-LabelAlias-Name"></a>
The name of an alias for a given label.  
Type: String  
Required: No

## See Also
<a name="API_LabelAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/LabelAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/LabelAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/LabelAlias) 

# LabelCategory
<a name="API_LabelCategory"></a>

The category that applies to a given label.

## Contents
<a name="API_LabelCategory_Contents"></a>

 ** Name **   <a name="rekognition-Type-LabelCategory-Name"></a>
The name of a category that applies to a given label.  
Type: String  
Required: No

## See Also
<a name="API_LabelCategory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/LabelCategory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/LabelCategory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/LabelCategory) 

# LabelDetection
<a name="API_LabelDetection"></a>

Information about a label detected in a video analysis request and the time the label was detected in the video. 

## Contents
<a name="API_LabelDetection_Contents"></a>

 ** DurationMillis **   <a name="rekognition-Type-LabelDetection-DurationMillis"></a>
The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** EndTimestampMillis **   <a name="rekognition-Type-LabelDetection-EndTimestampMillis"></a>
The time in milliseconds defining the end of the timeline segment containing a continuously detected label.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** Label **   <a name="rekognition-Type-LabelDetection-Label"></a>
Details about the detected label.  
Type: [Label](API_Label.md) object  
Required: No

 ** StartTimestampMillis **   <a name="rekognition-Type-LabelDetection-StartTimestampMillis"></a>
The time in milliseconds defining the start of the timeline segment containing a continuously detected label.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** Timestamp **   <a name="rekognition-Type-LabelDetection-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_LabelDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/LabelDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/LabelDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/LabelDetection) 

# LabelDetectionSettings
<a name="API_LabelDetectionSettings"></a>

Contains the specified filters that should be applied to a list of returned GENERAL\$1LABELS.

## Contents
<a name="API_LabelDetectionSettings_Contents"></a>

 ** GeneralLabels **   <a name="rekognition-Type-LabelDetectionSettings-GeneralLabels"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/labels.html).  
Type: [GeneralLabelsSettings](API_GeneralLabelsSettings.md) object  
Required: No

## See Also
<a name="API_LabelDetectionSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/LabelDetectionSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/LabelDetectionSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/LabelDetectionSettings) 

# Landmark
<a name="API_Landmark"></a>

Indicates the location of the landmark on the face.

## Contents
<a name="API_Landmark_Contents"></a>

 ** Type **   <a name="rekognition-Type-Landmark-Type"></a>
Type of landmark.  
Type: String  
Valid Values: `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`   
Required: No

 ** X **   <a name="rekognition-Type-Landmark-X"></a>
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.   
Type: Float  
Required: No

 ** Y **   <a name="rekognition-Type-Landmark-Y"></a>
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.  
Type: Float  
Required: No

## See Also
<a name="API_Landmark_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Landmark) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Landmark) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Landmark) 

# LivenessOutputConfig
<a name="API_LivenessOutputConfig"></a>

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. 

## Contents
<a name="API_LivenessOutputConfig_Contents"></a>

 ** S3Bucket **   <a name="rekognition-Type-LivenessOutputConfig-S3Bucket"></a>
The path to an AWS Amazon S3 bucket used to store Face Liveness session results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: Yes

 ** S3KeyPrefix **   <a name="rekognition-Type-LivenessOutputConfig-S3KeyPrefix"></a>
The prefix prepended to the output files for the Face Liveness session results.  
Type: String  
Length Constraints: Maximum length of 950.  
Pattern: `\S*`   
Required: No

## See Also
<a name="API_LivenessOutputConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/LivenessOutputConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/LivenessOutputConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/LivenessOutputConfig) 

# MatchedUser
<a name="API_MatchedUser"></a>

Contains metadata for a UserID matched with a given face.

## Contents
<a name="API_MatchedUser_Contents"></a>

 ** UserId **   <a name="rekognition-Type-MatchedUser-UserId"></a>
A provided ID for the UserID. Unique within the collection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** UserStatus **   <a name="rekognition-Type-MatchedUser-UserStatus"></a>
The status of the user matched to a provided FaceID.  
Type: String  
Valid Values: `ACTIVE | UPDATING | CREATING | CREATED`   
Required: No

## See Also
<a name="API_MatchedUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MatchedUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MatchedUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MatchedUser) 

# MediaAnalysisDetectModerationLabelsConfig
<a name="API_MediaAnalysisDetectModerationLabelsConfig"></a>

Configuration for Moderation Labels Detection.

## Contents
<a name="API_MediaAnalysisDetectModerationLabelsConfig_Contents"></a>

 ** MinConfidence **   <a name="rekognition-Type-MediaAnalysisDetectModerationLabelsConfig-MinConfidence"></a>
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.   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** ProjectVersion **   <a name="rekognition-Type-MediaAnalysisDetectModerationLabelsConfig-ProjectVersion"></a>
Specifies the custom moderation model to be used during the label detection job. If not provided the pre-trained model is used.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
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]+$)`   
Required: No

## See Also
<a name="API_MediaAnalysisDetectModerationLabelsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisDetectModerationLabelsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisDetectModerationLabelsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisDetectModerationLabelsConfig) 

# MediaAnalysisInput
<a name="API_MediaAnalysisInput"></a>

Contains input information for a media analysis job.

## Contents
<a name="API_MediaAnalysisInput_Contents"></a>

 ** S3Object **   <a name="rekognition-Type-MediaAnalysisInput-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: Yes

## See Also
<a name="API_MediaAnalysisInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisInput) 

# MediaAnalysisJobDescription
<a name="API_MediaAnalysisJobDescription"></a>

Description for a media analysis job.

## Contents
<a name="API_MediaAnalysisJobDescription_Contents"></a>

 ** CreationTimestamp **   <a name="rekognition-Type-MediaAnalysisJobDescription-CreationTimestamp"></a>
The Unix date and time when the job was started.  
Type: Timestamp  
Required: Yes

 ** Input **   <a name="rekognition-Type-MediaAnalysisJobDescription-Input"></a>
Reference to the input manifest that was provided in the job creation request.  
Type: [MediaAnalysisInput](API_MediaAnalysisInput.md) object  
Required: Yes

 ** JobId **   <a name="rekognition-Type-MediaAnalysisJobDescription-JobId"></a>
The identifier for a media analysis job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9-_]+$`   
Required: Yes

 ** OperationsConfig **   <a name="rekognition-Type-MediaAnalysisJobDescription-OperationsConfig"></a>
Operation configurations that were provided during job creation.  
Type: [MediaAnalysisOperationsConfig](API_MediaAnalysisOperationsConfig.md) object  
Required: Yes

 ** OutputConfig **   <a name="rekognition-Type-MediaAnalysisJobDescription-OutputConfig"></a>
Output configuration that was provided in the creation request.  
Type: [MediaAnalysisOutputConfig](API_MediaAnalysisOutputConfig.md) object  
Required: Yes

 ** Status **   <a name="rekognition-Type-MediaAnalysisJobDescription-Status"></a>
The status of the media analysis job being retrieved.  
Type: String  
Valid Values: `CREATED | QUEUED | IN_PROGRESS | SUCCEEDED | FAILED`   
Required: Yes

 ** CompletionTimestamp **   <a name="rekognition-Type-MediaAnalysisJobDescription-CompletionTimestamp"></a>
The Unix date and time when the job finished.  
Type: Timestamp  
Required: No

 ** FailureDetails **   <a name="rekognition-Type-MediaAnalysisJobDescription-FailureDetails"></a>
Details about the error that resulted in failure of the job.  
Type: [MediaAnalysisJobFailureDetails](API_MediaAnalysisJobFailureDetails.md) object  
Required: No

 ** JobName **   <a name="rekognition-Type-MediaAnalysisJobDescription-JobName"></a>
The name of a media analysis job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_.\-]+`   
Required: No

 ** KmsKeyId **   <a name="rekognition-Type-MediaAnalysisJobDescription-KmsKeyId"></a>
KMS Key that was provided in the creation request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** ManifestSummary **   <a name="rekognition-Type-MediaAnalysisJobDescription-ManifestSummary"></a>
Provides statistics on input manifest and errors identified in the input manifest.  
Type: [MediaAnalysisManifestSummary](API_MediaAnalysisManifestSummary.md) object  
Required: No

 ** Results **   <a name="rekognition-Type-MediaAnalysisJobDescription-Results"></a>
Output manifest that contains prediction results.  
Type: [MediaAnalysisResults](API_MediaAnalysisResults.md) object  
Required: No

## See Also
<a name="API_MediaAnalysisJobDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisJobDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisJobDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisJobDescription) 

# MediaAnalysisJobFailureDetails
<a name="API_MediaAnalysisJobFailureDetails"></a>

Details about the error that resulted in failure of the job.

## Contents
<a name="API_MediaAnalysisJobFailureDetails_Contents"></a>

 ** Code **   <a name="rekognition-Type-MediaAnalysisJobFailureDetails-Code"></a>
Error code for the failed job.  
Type: String  
Valid Values: `INTERNAL_ERROR | INVALID_S3_OBJECT | INVALID_MANIFEST | INVALID_OUTPUT_CONFIG | INVALID_KMS_KEY | ACCESS_DENIED | RESOURCE_NOT_FOUND | RESOURCE_NOT_READY | THROTTLED`   
Required: No

 ** Message **   <a name="rekognition-Type-MediaAnalysisJobFailureDetails-Message"></a>
Human readable error message.  
Type: String  
Required: No

## See Also
<a name="API_MediaAnalysisJobFailureDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisJobFailureDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisJobFailureDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisJobFailureDetails) 

# MediaAnalysisManifestSummary
<a name="API_MediaAnalysisManifestSummary"></a>

Summary that provides statistics on input manifest and errors identified in the input manifest.

## Contents
<a name="API_MediaAnalysisManifestSummary_Contents"></a>

 ** S3Object **   <a name="rekognition-Type-MediaAnalysisManifestSummary-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_MediaAnalysisManifestSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisManifestSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisManifestSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisManifestSummary) 

# MediaAnalysisModelVersions
<a name="API_MediaAnalysisModelVersions"></a>

Object containing information about the model versions of selected features in a given job.

## Contents
<a name="API_MediaAnalysisModelVersions_Contents"></a>

 ** Moderation **   <a name="rekognition-Type-MediaAnalysisModelVersions-Moderation"></a>
The Moderation base model version.  
Type: String  
Required: No

## See Also
<a name="API_MediaAnalysisModelVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisModelVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisModelVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisModelVersions) 

# MediaAnalysisOperationsConfig
<a name="API_MediaAnalysisOperationsConfig"></a>

Configuration options for a media analysis job. Configuration is operation-specific.

## Contents
<a name="API_MediaAnalysisOperationsConfig_Contents"></a>

 ** DetectModerationLabels **   <a name="rekognition-Type-MediaAnalysisOperationsConfig-DetectModerationLabels"></a>
Contains configuration options for a DetectModerationLabels job.  
Type: [MediaAnalysisDetectModerationLabelsConfig](API_MediaAnalysisDetectModerationLabelsConfig.md) object  
Required: No

## See Also
<a name="API_MediaAnalysisOperationsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisOperationsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisOperationsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisOperationsConfig) 

# MediaAnalysisOutputConfig
<a name="API_MediaAnalysisOutputConfig"></a>

Output configuration provided in the job creation request.

## Contents
<a name="API_MediaAnalysisOutputConfig_Contents"></a>

 ** S3Bucket **   <a name="rekognition-Type-MediaAnalysisOutputConfig-S3Bucket"></a>
Specifies the Amazon S3 bucket to contain the output of the media analysis job.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: Yes

 ** S3KeyPrefix **   <a name="rekognition-Type-MediaAnalysisOutputConfig-S3KeyPrefix"></a>
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for storage.  
Type: String  
Length Constraints: Maximum length of 800.  
Pattern: `\S*`   
Required: No

## See Also
<a name="API_MediaAnalysisOutputConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisOutputConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisOutputConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisOutputConfig) 

# MediaAnalysisResults
<a name="API_MediaAnalysisResults"></a>

Contains the results for a media analysis job created with StartMediaAnalysisJob.

## Contents
<a name="API_MediaAnalysisResults_Contents"></a>

 ** ModelVersions **   <a name="rekognition-Type-MediaAnalysisResults-ModelVersions"></a>
Information about the model versions for the features selected in a given job.  
Type: [MediaAnalysisModelVersions](API_MediaAnalysisModelVersions.md) object  
Required: No

 ** S3Object **   <a name="rekognition-Type-MediaAnalysisResults-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_MediaAnalysisResults_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MediaAnalysisResults) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MediaAnalysisResults) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MediaAnalysisResults) 

# ModerationLabel
<a name="API_ModerationLabel"></a>

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 a list of moderation labels in Amazon Rekognition, see [Using the image and video moderation APIs](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api). For more information, see [Moderating content](https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html).

## Contents
<a name="API_ModerationLabel_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-ModerationLabel-Confidence"></a>
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.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Name **   <a name="rekognition-Type-ModerationLabel-Name"></a>
The label name for the type of unsafe content detected in the image.  
Type: String  
Required: No

 ** ParentName **   <a name="rekognition-Type-ModerationLabel-ParentName"></a>
The name for the parent label. Labels at the top level of the hierarchy have the parent label `""`.  
Type: String  
Required: No

 ** TaxonomyLevel **   <a name="rekognition-Type-ModerationLabel-TaxonomyLevel"></a>
The level of the moderation label with regard to its taxonomy, from 1 to 3.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_ModerationLabel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ModerationLabel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ModerationLabel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ModerationLabel) 

# MouthOpen
<a name="API_MouthOpen"></a>

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

## Contents
<a name="API_MouthOpen_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-MouthOpen-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-MouthOpen-Value"></a>
Boolean value that indicates whether the mouth on the face is open or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_MouthOpen_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/MouthOpen) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/MouthOpen) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/MouthOpen) 

# Mustache
<a name="API_Mustache"></a>

Indicates whether or not the face has a mustache, and the confidence level in the determination.

## Contents
<a name="API_Mustache_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Mustache-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Mustache-Value"></a>
Boolean value that indicates whether the face has mustache or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_Mustache_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Mustache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Mustache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Mustache) 

# NotificationChannel
<a name="API_NotificationChannel"></a>

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](https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html). 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](https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics).

## Contents
<a name="API_NotificationChannel_Contents"></a>

 ** RoleArn **   <a name="rekognition-Type-NotificationChannel-RoleArn"></a>
The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.   
Type: String  
Pattern: `arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
Required: Yes

 ** SNSTopicArn **   <a name="rekognition-Type-NotificationChannel-SNSTopicArn"></a>
The Amazon SNS topic to which Amazon Rekognition posts the completion status.  
Type: String  
Pattern: `(^arn:aws:sns:.*:\w{12}:.+$)`   
Required: Yes

## See Also
<a name="API_NotificationChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/NotificationChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/NotificationChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/NotificationChannel) 

# OutputConfig
<a name="API_OutputConfig"></a>

The S3 bucket and folder location where training output is placed.

## Contents
<a name="API_OutputConfig_Contents"></a>

 ** S3Bucket **   <a name="rekognition-Type-OutputConfig-S3Bucket"></a>
The S3 bucket where training output is placed.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: No

 ** S3KeyPrefix **   <a name="rekognition-Type-OutputConfig-S3KeyPrefix"></a>
The prefix applied to the training output files.   
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_OutputConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/OutputConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/OutputConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/OutputConfig) 

# Parent
<a name="API_Parent"></a>

A parent label for a label. A label can have 0, 1, or more parents. 

## Contents
<a name="API_Parent_Contents"></a>

 ** Name **   <a name="rekognition-Type-Parent-Name"></a>
The name of the parent label.  
Type: String  
Required: No

## See Also
<a name="API_Parent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Parent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Parent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Parent) 

# PersonDetail
<a name="API_PersonDetail"></a>

Details about a person detected in a video analysis request.

## Contents
<a name="API_PersonDetail_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-PersonDetail-BoundingBox"></a>
Bounding box around the detected person.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Face **   <a name="rekognition-Type-PersonDetail-Face"></a>
Face details for the detected person.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

 ** Index **   <a name="rekognition-Type-PersonDetail-Index"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_PersonDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/PersonDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/PersonDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/PersonDetail) 

# PersonDetection
<a name="API_PersonDetection"></a>

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](API_GetPersonTracking.md). 

## Contents
<a name="API_PersonDetection_Contents"></a>

 ** Person **   <a name="rekognition-Type-PersonDetection-Person"></a>
Details about a person whose path was tracked in a video.  
Type: [PersonDetail](API_PersonDetail.md) object  
Required: No

 ** Timestamp **   <a name="rekognition-Type-PersonDetection-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_PersonDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/PersonDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/PersonDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/PersonDetection) 

# PersonMatch
<a name="API_PersonMatch"></a>

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](API_FaceMatch.md)), information about the person ([PersonDetail](API_PersonDetail.md)), and the time stamp for when the person was detected in a video. An array of `PersonMatch` objects is returned by [GetFaceSearch](API_GetFaceSearch.md). 

## Contents
<a name="API_PersonMatch_Contents"></a>

 ** FaceMatches **   <a name="rekognition-Type-PersonMatch-FaceMatches"></a>
Information about the faces in the input collection that match the face of a person in the video.  
Type: Array of [FaceMatch](API_FaceMatch.md) objects  
Required: No

 ** Person **   <a name="rekognition-Type-PersonMatch-Person"></a>
Information about the matched person.  
Type: [PersonDetail](API_PersonDetail.md) object  
Required: No

 ** Timestamp **   <a name="rekognition-Type-PersonMatch-Timestamp"></a>
The time, in milliseconds from the beginning of the video, that the person was matched in the video.  
Type: Long  
Required: No

## See Also
<a name="API_PersonMatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/PersonMatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/PersonMatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/PersonMatch) 

# Point
<a name="API_Point"></a>

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, `Polygon`, is returned by [DetectText](API_DetectText.md) and [DetectCustomLabels](API_DetectCustomLabels.md) or used to define regions of interest in Amazon Rekognition Video operations such as `CreateStreamProcessor`. `Polygon` represents a fine-grained polygon around a detected item. For more information, see [Geometry](API_Geometry.md). 

## Contents
<a name="API_Point_Contents"></a>

 ** X **   <a name="rekognition-Type-Point-X"></a>
The value of the X coordinate for a point on a `Polygon`.  
Type: Float  
Required: No

 ** Y **   <a name="rekognition-Type-Point-Y"></a>
The value of the Y coordinate for a point on a `Polygon`.  
Type: Float  
Required: No

## See Also
<a name="API_Point_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Point) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Point) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Point) 

# Pose
<a name="API_Pose"></a>

Indicates the pose of the face as determined by its pitch, roll, and yaw.

## Contents
<a name="API_Pose_Contents"></a>

 ** Pitch **   <a name="rekognition-Type-Pose-Pitch"></a>
Value representing the face rotation on the pitch axis.  
Type: Float  
Valid Range: Minimum value of -180. Maximum value of 180.  
Required: No

 ** Roll **   <a name="rekognition-Type-Pose-Roll"></a>
Value representing the face rotation on the roll axis.  
Type: Float  
Valid Range: Minimum value of -180. Maximum value of 180.  
Required: No

 ** Yaw **   <a name="rekognition-Type-Pose-Yaw"></a>
Value representing the face rotation on the yaw axis.  
Type: Float  
Valid Range: Minimum value of -180. Maximum value of 180.  
Required: No

## See Also
<a name="API_Pose_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Pose) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Pose) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Pose) 

# ProjectDescription
<a name="API_ProjectDescription"></a>

A description of an Amazon Rekognition Custom Labels project. For more information, see [DescribeProjects](API_DescribeProjects.md).

## Contents
<a name="API_ProjectDescription_Contents"></a>

 ** AutoUpdate **   <a name="rekognition-Type-ProjectDescription-AutoUpdate"></a>
Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** CreationTimestamp **   <a name="rekognition-Type-ProjectDescription-CreationTimestamp"></a>
The Unix timestamp for the date and time that the project was created.  
Type: Timestamp  
Required: No

 ** Datasets **   <a name="rekognition-Type-ProjectDescription-Datasets"></a>
 Information about the training and test datasets in the project.   
Type: Array of [DatasetMetadata](API_DatasetMetadata.md) objects  
Required: No

 ** Feature **   <a name="rekognition-Type-ProjectDescription-Feature"></a>
Specifies the project that is being customized.  
Type: String  
Valid Values: `CONTENT_MODERATION | CUSTOM_LABELS`   
Required: No

 ** ProjectArn **   <a name="rekognition-Type-ProjectDescription-ProjectArn"></a>
The Amazon Resource Name (ARN) of the project.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)`   
Required: No

 ** Status **   <a name="rekognition-Type-ProjectDescription-Status"></a>
The current status of the project.  
Type: String  
Valid Values: `CREATING | CREATED | DELETING`   
Required: No

## See Also
<a name="API_ProjectDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProjectDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProjectDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProjectDescription) 

# ProjectPolicy
<a name="API_ProjectPolicy"></a>

Describes a project policy in the response from [ListProjectPolicies](API_ListProjectPolicies.md). 

 

## Contents
<a name="API_ProjectPolicy_Contents"></a>

 ** CreationTimestamp **   <a name="rekognition-Type-ProjectPolicy-CreationTimestamp"></a>
The Unix datetime for the creation of the project policy.  
Type: Timestamp  
Required: No

 ** LastUpdatedTimestamp **   <a name="rekognition-Type-ProjectPolicy-LastUpdatedTimestamp"></a>
The Unix datetime for when the project policy was last updated.   
Type: Timestamp  
Required: No

 ** PolicyDocument **   <a name="rekognition-Type-ProjectPolicy-PolicyDocument"></a>
The JSON document for the project policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+`   
Required: No

 ** PolicyName **   <a name="rekognition-Type-ProjectPolicy-PolicyName"></a>
The name of the project policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-]+`   
Required: No

 ** PolicyRevisionId **   <a name="rekognition-Type-ProjectPolicy-PolicyRevisionId"></a>
The revision ID of the project policy.  
Type: String  
Length Constraints: Maximum length of 64.  
Pattern: `[0-9A-Fa-f]+`   
Required: No

 ** ProjectArn **   <a name="rekognition-Type-ProjectPolicy-ProjectArn"></a>
The Amazon Resource Name (ARN) of the project to which the project policy is attached.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/[0-9]+$)`   
Required: No

## See Also
<a name="API_ProjectPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProjectPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProjectPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProjectPolicy) 

# ProjectVersionDescription
<a name="API_ProjectVersionDescription"></a>

A description of a version of a Amazon Rekognition project version.

## Contents
<a name="API_ProjectVersionDescription_Contents"></a>

 ** BaseModelVersion **   <a name="rekognition-Type-ProjectVersionDescription-BaseModelVersion"></a>
The base detection model version used to create the project version.  
Type: String  
Required: No

 ** BillableTrainingTimeInSeconds **   <a name="rekognition-Type-ProjectVersionDescription-BillableTrainingTimeInSeconds"></a>
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.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** CreationTimestamp **   <a name="rekognition-Type-ProjectVersionDescription-CreationTimestamp"></a>
The Unix datetime for the date and time that training started.  
Type: Timestamp  
Required: No

 ** EvaluationResult **   <a name="rekognition-Type-ProjectVersionDescription-EvaluationResult"></a>
The training results. `EvaluationResult` is only returned if training is successful.  
Type: [EvaluationResult](API_EvaluationResult.md) object  
Required: No

 ** Feature **   <a name="rekognition-Type-ProjectVersionDescription-Feature"></a>
The feature that was customized.  
Type: String  
Valid Values: `CONTENT_MODERATION | CUSTOM_LABELS`   
Required: No

 ** FeatureConfig **   <a name="rekognition-Type-ProjectVersionDescription-FeatureConfig"></a>
Feature specific configuration that was applied during training.  
Type: [CustomizationFeatureConfig](API_CustomizationFeatureConfig.md) object  
Required: No

 ** KmsKeyId **   <a name="rekognition-Type-ProjectVersionDescription-KmsKeyId"></a>
The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$`   
Required: No

 ** ManifestSummary **   <a name="rekognition-Type-ProjectVersionDescription-ManifestSummary"></a>
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.  
Type: [GroundTruthManifest](API_GroundTruthManifest.md) object  
Required: No

 ** MaxInferenceUnits **   <a name="rekognition-Type-ProjectVersionDescription-MaxInferenceUnits"></a>
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](API_StartProjectVersion.md).  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** MinInferenceUnits **   <a name="rekognition-Type-ProjectVersionDescription-MinInferenceUnits"></a>
The minimum number of inference units used by the model. Applies only to Custom Labels projects. For more information, see [StartProjectVersion](API_StartProjectVersion.md).  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** OutputConfig **   <a name="rekognition-Type-ProjectVersionDescription-OutputConfig"></a>
The location where training results are saved.  
Type: [OutputConfig](API_OutputConfig.md) object  
Required: No

 ** ProjectVersionArn **   <a name="rekognition-Type-ProjectVersionDescription-ProjectVersionArn"></a>
The Amazon Resource Name (ARN) of the project version.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
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]+$)`   
Required: No

 ** SourceProjectVersionArn **   <a name="rekognition-Type-ProjectVersionDescription-SourceProjectVersionArn"></a>
If the model version was copied from a different project, `SourceProjectVersionArn` contains the ARN of the source model version.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
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]+$)`   
Required: No

 ** Status **   <a name="rekognition-Type-ProjectVersionDescription-Status"></a>
The current status of the model version.  
Type: String  
Valid Values: `TRAINING_IN_PROGRESS | TRAINING_COMPLETED | TRAINING_FAILED | STARTING | RUNNING | FAILED | STOPPING | STOPPED | DELETING | COPYING_IN_PROGRESS | COPYING_COMPLETED | COPYING_FAILED | DEPRECATED | EXPIRED`   
Required: No

 ** StatusMessage **   <a name="rekognition-Type-ProjectVersionDescription-StatusMessage"></a>
A descriptive message for an error or warning that occurred.  
Type: String  
Required: No

 ** TestingDataResult **   <a name="rekognition-Type-ProjectVersionDescription-TestingDataResult"></a>
Contains information about the testing results.  
Type: [TestingDataResult](API_TestingDataResult.md) object  
Required: No

 ** TrainingDataResult **   <a name="rekognition-Type-ProjectVersionDescription-TrainingDataResult"></a>
Contains information about the training results.  
Type: [TrainingDataResult](API_TrainingDataResult.md) object  
Required: No

 ** TrainingEndTimestamp **   <a name="rekognition-Type-ProjectVersionDescription-TrainingEndTimestamp"></a>
The Unix date and time that training of the model ended.  
Type: Timestamp  
Required: No

 ** VersionDescription **   <a name="rekognition-Type-ProjectVersionDescription-VersionDescription"></a>
A user-provided description of the project version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9-_. ()':,;?]+`   
Required: No

## See Also
<a name="API_ProjectVersionDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProjectVersionDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProjectVersionDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProjectVersionDescription) 

# ProtectiveEquipmentBodyPart
<a name="API_ProtectiveEquipmentBodyPart"></a>

Information about a body part detected by [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md) that contains PPE. An array of `ProtectiveEquipmentBodyPart` objects is returned for each person detected by `DetectProtectiveEquipment`. 

## Contents
<a name="API_ProtectiveEquipmentBodyPart_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-ProtectiveEquipmentBodyPart-Confidence"></a>
The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** EquipmentDetections **   <a name="rekognition-Type-ProtectiveEquipmentBodyPart-EquipmentDetections"></a>
An array of Personal Protective Equipment items detected around a body part.  
Type: Array of [EquipmentDetection](API_EquipmentDetection.md) objects  
Required: No

 ** Name **   <a name="rekognition-Type-ProtectiveEquipmentBodyPart-Name"></a>
The detected body part.  
Type: String  
Valid Values: `FACE | HEAD | LEFT_HAND | RIGHT_HAND`   
Required: No

## See Also
<a name="API_ProtectiveEquipmentBodyPart_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProtectiveEquipmentBodyPart) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProtectiveEquipmentBodyPart) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProtectiveEquipmentBodyPart) 

# ProtectiveEquipmentPerson
<a name="API_ProtectiveEquipmentPerson"></a>

A person detected by a call to [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md). The API returns all persons detected in the input image in an array of `ProtectiveEquipmentPerson` objects.

## Contents
<a name="API_ProtectiveEquipmentPerson_Contents"></a>

 ** BodyParts **   <a name="rekognition-Type-ProtectiveEquipmentPerson-BodyParts"></a>
An array of body parts detected on a person's body (including body parts without PPE).   
Type: Array of [ProtectiveEquipmentBodyPart](API_ProtectiveEquipmentBodyPart.md) objects  
Required: No

 ** BoundingBox **   <a name="rekognition-Type-ProtectiveEquipmentPerson-BoundingBox"></a>
A bounding box around the detected person.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Confidence **   <a name="rekognition-Type-ProtectiveEquipmentPerson-Confidence"></a>
The confidence that Amazon Rekognition has that the bounding box contains a person.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Id **   <a name="rekognition-Type-ProtectiveEquipmentPerson-Id"></a>
The identifier for the detected person. The identifier is only unique for a single call to `DetectProtectiveEquipment`.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_ProtectiveEquipmentPerson_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProtectiveEquipmentPerson) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProtectiveEquipmentPerson) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProtectiveEquipmentPerson) 

# ProtectiveEquipmentSummarizationAttributes
<a name="API_ProtectiveEquipmentSummarizationAttributes"></a>

Specifies summary attributes to return from a call to [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md). 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](API_ProtectiveEquipmentSummary.md)) 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](API_ProtectiveEquipmentSummary.md).

## Contents
<a name="API_ProtectiveEquipmentSummarizationAttributes_Contents"></a>

 ** MinConfidence **   <a name="rekognition-Type-ProtectiveEquipmentSummarizationAttributes-MinConfidence"></a>
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%.  
   
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: Yes

 ** RequiredEquipmentTypes **   <a name="rekognition-Type-ProtectiveEquipmentSummarizationAttributes-RequiredEquipmentTypes"></a>
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](API_ProtectiveEquipmentSummary.md) by `DetectProtectiveEquipment`.   
Type: Array of strings  
Valid Values: `FACE_COVER | HAND_COVER | HEAD_COVER`   
Required: Yes

## See Also
<a name="API_ProtectiveEquipmentSummarizationAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProtectiveEquipmentSummarizationAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProtectiveEquipmentSummarizationAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProtectiveEquipmentSummarizationAttributes) 

# ProtectiveEquipmentSummary
<a name="API_ProtectiveEquipmentSummary"></a>

Summary information for required items of personal protective equipment (PPE) detected on persons by a call to [DetectProtectiveEquipment](API_DetectProtectiveEquipment.md). You specify the required type of PPE in the `SummarizationAttributes` ([ProtectiveEquipmentSummarizationAttributes](API_ProtectiveEquipmentSummarizationAttributes.md)) 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](API_BoundingBox.md)) of the person on the image, use the person ID in each array element. Each person ID matches the ID field of a [ProtectiveEquipmentPerson](API_ProtectiveEquipmentPerson.md) object returned in the `Persons` array by `DetectProtectiveEquipment`.

## Contents
<a name="API_ProtectiveEquipmentSummary_Contents"></a>

 ** PersonsIndeterminate **   <a name="rekognition-Type-ProtectiveEquipmentSummary-PersonsIndeterminate"></a>
An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.   
Type: Array of integers  
Valid Range: Minimum value of 0.  
Required: No

 ** PersonsWithoutRequiredEquipment **   <a name="rekognition-Type-ProtectiveEquipmentSummary-PersonsWithoutRequiredEquipment"></a>
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.   
Type: Array of integers  
Valid Range: Minimum value of 0.  
Required: No

 ** PersonsWithRequiredEquipment **   <a name="rekognition-Type-ProtectiveEquipmentSummary-PersonsWithRequiredEquipment"></a>
An array of IDs for persons who are wearing detected personal protective equipment.   
Type: Array of integers  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_ProtectiveEquipmentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ProtectiveEquipmentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ProtectiveEquipmentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ProtectiveEquipmentSummary) 

# RegionOfInterest
<a name="API_RegionOfInterest"></a>

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.

## Contents
<a name="API_RegionOfInterest_Contents"></a>

 ** BoundingBox **   <a name="rekognition-Type-RegionOfInterest-BoundingBox"></a>
The box representing a region of interest on screen.  
Type: [BoundingBox](API_BoundingBox.md) object  
Required: No

 ** Polygon **   <a name="rekognition-Type-RegionOfInterest-Polygon"></a>
 Specifies a shape made up of up to 10 `Point` objects to define a region of interest.   
Type: Array of [Point](API_Point.md) objects  
Required: No

## See Also
<a name="API_RegionOfInterest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/RegionOfInterest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/RegionOfInterest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/RegionOfInterest) 

# S3Destination
<a name="API_S3Destination"></a>

 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. 

## Contents
<a name="API_S3Destination_Contents"></a>

 ** Bucket **   <a name="rekognition-Type-S3Destination-Bucket"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: No

 ** KeyPrefix **   <a name="rekognition-Type-S3Destination-KeyPrefix"></a>
 The prefix value of the location within the bucket that you want the information to be published to. For more information, see [Using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html).   
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## See Also
<a name="API_S3Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/S3Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/S3Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/S3Destination) 

# S3Object
<a name="API_S3Object"></a>

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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html). 

## Contents
<a name="API_S3Object_Contents"></a>

 ** Bucket **   <a name="rekognition-Type-S3Object-Bucket"></a>
Name of the S3 bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 255.  
Pattern: `[0-9A-Za-z\.\-_]*`   
Required: No

 ** Name **   <a name="rekognition-Type-S3Object-Name"></a>
S3 object key name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** Version **   <a name="rekognition-Type-S3Object-Version"></a>
If the bucket is versioning enabled, you can specify the object version.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_S3Object_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/S3Object) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/S3Object) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/S3Object) 

# SearchedFace
<a name="API_SearchedFace"></a>

Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.

## Contents
<a name="API_SearchedFace_Contents"></a>

 ** FaceId **   <a name="rekognition-Type-SearchedFace-FaceId"></a>
 Unique identifier assigned to the face.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

## See Also
<a name="API_SearchedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SearchedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SearchedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SearchedFace) 

# SearchedFaceDetails
<a name="API_SearchedFaceDetails"></a>

Contains data regarding the input face used for a search.

## Contents
<a name="API_SearchedFaceDetails_Contents"></a>

 ** FaceDetail **   <a name="rekognition-Type-SearchedFaceDetails-FaceDetail"></a>
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](API_GetFaceDetection.md) 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](API_StartFaceDetection.md). 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](API_DetectFaces.md) and [IndexFaces](API_IndexFaces.md) 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.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

## See Also
<a name="API_SearchedFaceDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SearchedFaceDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SearchedFaceDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SearchedFaceDetails) 

# SearchedUser
<a name="API_SearchedUser"></a>

Contains metadata about a User searched for within a collection.

## Contents
<a name="API_SearchedUser_Contents"></a>

 ** UserId **   <a name="rekognition-Type-SearchedUser-UserId"></a>
 A provided ID for the UserID. Unique within the collection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

## See Also
<a name="API_SearchedUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SearchedUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SearchedUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SearchedUser) 

# SegmentDetection
<a name="API_SegmentDetection"></a>

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](API_GetSegmentDetection.md). 

## Contents
<a name="API_SegmentDetection_Contents"></a>

 ** DurationFrames **   <a name="rekognition-Type-SegmentDetection-DurationFrames"></a>
 The duration of a video segment, expressed in frames.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** DurationMillis **   <a name="rekognition-Type-SegmentDetection-DurationMillis"></a>
The duration of the detected segment in milliseconds.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** DurationSMPTE **   <a name="rekognition-Type-SegmentDetection-DurationSMPTE"></a>
The duration of the timecode for the detected segment in SMPTE format.  
Type: String  
Required: No

 ** EndFrameNumber **   <a name="rekognition-Type-SegmentDetection-EndFrameNumber"></a>
 The frame number at the end of a video segment, using a frame index that starts with 0.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** EndTimecodeSMPTE **   <a name="rekognition-Type-SegmentDetection-EndTimecodeSMPTE"></a>
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).  
Type: String  
Required: No

 ** EndTimestampMillis **   <a name="rekognition-Type-SegmentDetection-EndTimestampMillis"></a>
The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.  
Type: Long  
Required: No

 ** ShotSegment **   <a name="rekognition-Type-SegmentDetection-ShotSegment"></a>
If the segment is a shot detection, contains information about the shot detection.  
Type: [ShotSegment](API_ShotSegment.md) object  
Required: No

 ** StartFrameNumber **   <a name="rekognition-Type-SegmentDetection-StartFrameNumber"></a>
 The frame number of the start of a video segment, using a frame index that starts with 0.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** StartTimecodeSMPTE **   <a name="rekognition-Type-SegmentDetection-StartTimecodeSMPTE"></a>
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).   
Type: String  
Required: No

 ** StartTimestampMillis **   <a name="rekognition-Type-SegmentDetection-StartTimestampMillis"></a>
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.  
Type: Long  
Required: No

 ** TechnicalCueSegment **   <a name="rekognition-Type-SegmentDetection-TechnicalCueSegment"></a>
If the segment is a technical cue, contains information about the technical cue.  
Type: [TechnicalCueSegment](API_TechnicalCueSegment.md) object  
Required: No

 ** Type **   <a name="rekognition-Type-SegmentDetection-Type"></a>
The type of the segment. Valid values are `TECHNICAL_CUE` and `SHOT`.  
Type: String  
Valid Values: `TECHNICAL_CUE | SHOT`   
Required: No

## See Also
<a name="API_SegmentDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SegmentDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SegmentDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SegmentDetection) 

# SegmentTypeInfo
<a name="API_SegmentTypeInfo"></a>

Information about the type of a segment requested in a call to [StartSegmentDetection](API_StartSegmentDetection.md). An array of `SegmentTypeInfo` objects is returned by the response from [GetSegmentDetection](API_GetSegmentDetection.md).

## Contents
<a name="API_SegmentTypeInfo_Contents"></a>

 ** ModelVersion **   <a name="rekognition-Type-SegmentTypeInfo-ModelVersion"></a>
The version of the model used to detect segments.  
Type: String  
Required: No

 ** Type **   <a name="rekognition-Type-SegmentTypeInfo-Type"></a>
The type of a segment (technical cue or shot detection).  
Type: String  
Valid Values: `TECHNICAL_CUE | SHOT`   
Required: No

## See Also
<a name="API_SegmentTypeInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/SegmentTypeInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/SegmentTypeInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/SegmentTypeInfo) 

# ShotSegment
<a name="API_ShotSegment"></a>

Information about a shot detection segment detected in a video. For more information, see [SegmentDetection](API_SegmentDetection.md).

## Contents
<a name="API_ShotSegment_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-ShotSegment-Confidence"></a>
The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.  
Type: Float  
Valid Range: Minimum value of 50. Maximum value of 100.  
Required: No

 ** Index **   <a name="rekognition-Type-ShotSegment-Index"></a>
An Identifier for a shot detection segment detected in a video.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_ShotSegment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ShotSegment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ShotSegment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ShotSegment) 

# Smile
<a name="API_Smile"></a>

Indicates whether or not the face is smiling, and the confidence level in the determination.

## Contents
<a name="API_Smile_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Smile-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Smile-Value"></a>
Boolean value that indicates whether the face is smiling or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_Smile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Smile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Smile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Smile) 

# StartSegmentDetectionFilters
<a name="API_StartSegmentDetectionFilters"></a>

Filters applied to the technical cue or shot detection segments. For more information, see [StartSegmentDetection](API_StartSegmentDetection.md). 

## Contents
<a name="API_StartSegmentDetectionFilters_Contents"></a>

 ** ShotFilter **   <a name="rekognition-Type-StartSegmentDetectionFilters-ShotFilter"></a>
Filters that are specific to shot detections.  
Type: [StartShotDetectionFilter](API_StartShotDetectionFilter.md) object  
Required: No

 ** TechnicalCueFilter **   <a name="rekognition-Type-StartSegmentDetectionFilters-TechnicalCueFilter"></a>
Filters that are specific to technical cues.  
Type: [StartTechnicalCueDetectionFilter](API_StartTechnicalCueDetectionFilter.md) object  
Required: No

## See Also
<a name="API_StartSegmentDetectionFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StartSegmentDetectionFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StartSegmentDetectionFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StartSegmentDetectionFilters) 

# StartShotDetectionFilter
<a name="API_StartShotDetectionFilter"></a>

Filters for the shot detection segments returned by `GetSegmentDetection`. For more information, see [StartSegmentDetectionFilters](API_StartSegmentDetectionFilters.md).

## Contents
<a name="API_StartShotDetectionFilter_Contents"></a>

 ** MinSegmentConfidence **   <a name="rekognition-Type-StartShotDetectionFilter-MinSegmentConfidence"></a>
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.  
Type: Float  
Valid Range: Minimum value of 50. Maximum value of 100.  
Required: No

## See Also
<a name="API_StartShotDetectionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StartShotDetectionFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StartShotDetectionFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StartShotDetectionFilter) 

# StartTechnicalCueDetectionFilter
<a name="API_StartTechnicalCueDetectionFilter"></a>

Filters for the technical segments returned by [GetSegmentDetection](API_GetSegmentDetection.md). For more information, see [StartSegmentDetectionFilters](API_StartSegmentDetectionFilters.md).

## Contents
<a name="API_StartTechnicalCueDetectionFilter_Contents"></a>

 ** BlackFrame **   <a name="rekognition-Type-StartTechnicalCueDetectionFilter-BlackFrame"></a>
 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.   
Type: [BlackFrame](API_BlackFrame.md) object  
Required: No

 ** MinSegmentConfidence **   <a name="rekognition-Type-StartTechnicalCueDetectionFilter-MinSegmentConfidence"></a>
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.  
Type: Float  
Valid Range: Minimum value of 50. Maximum value of 100.  
Required: No

## See Also
<a name="API_StartTechnicalCueDetectionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StartTechnicalCueDetectionFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StartTechnicalCueDetectionFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StartTechnicalCueDetectionFilter) 

# StartTextDetectionFilters
<a name="API_StartTextDetectionFilters"></a>

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.

## Contents
<a name="API_StartTextDetectionFilters_Contents"></a>

 ** RegionsOfInterest **   <a name="rekognition-Type-StartTextDetectionFilters-RegionsOfInterest"></a>
Filter focusing on a certain area of the frame. Uses a `BoundingBox` object to set the region of the screen.  
Type: Array of [RegionOfInterest](API_RegionOfInterest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** WordFilter **   <a name="rekognition-Type-StartTextDetectionFilters-WordFilter"></a>
Filters focusing on qualities of the text, such as confidence or size.  
Type: [DetectionFilter](API_DetectionFilter.md) object  
Required: No

## See Also
<a name="API_StartTextDetectionFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StartTextDetectionFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StartTextDetectionFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StartTextDetectionFilters) 

# StreamProcessingStartSelector
<a name="API_StreamProcessingStartSelector"></a>

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

## Contents
<a name="API_StreamProcessingStartSelector_Contents"></a>

 ** KVSStreamStartSelector **   <a name="rekognition-Type-StreamProcessingStartSelector-KVSStreamStartSelector"></a>
 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.   
Type: [KinesisVideoStreamStartSelector](API_KinesisVideoStreamStartSelector.md) object  
Required: No

## See Also
<a name="API_StreamProcessingStartSelector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessingStartSelector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessingStartSelector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessingStartSelector) 

# StreamProcessingStopSelector
<a name="API_StreamProcessingStopSelector"></a>

 Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video. 

## Contents
<a name="API_StreamProcessingStopSelector_Contents"></a>

 ** MaxDurationInSeconds **   <a name="rekognition-Type-StreamProcessingStopSelector-MaxDurationInSeconds"></a>
 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.   
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 120.  
Required: No

## See Also
<a name="API_StreamProcessingStopSelector_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessingStopSelector) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessingStopSelector) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessingStopSelector) 

# StreamProcessor
<a name="API_StreamProcessor"></a>

An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to [CreateStreamProcessor](API_CreateStreamProcessor.md). 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. 

## Contents
<a name="API_StreamProcessor_Contents"></a>

 ** Name **   <a name="rekognition-Type-StreamProcessor-Name"></a>
Name of the Amazon Rekognition stream processor.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-]+`   
Required: No

 ** Status **   <a name="rekognition-Type-StreamProcessor-Status"></a>
Current status of the Amazon Rekognition stream processor.  
Type: String  
Valid Values: `STOPPED | STARTING | RUNNING | FAILED | STOPPING | UPDATING`   
Required: No

## See Also
<a name="API_StreamProcessor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessor) 

# StreamProcessorDataSharingPreference
<a name="API_StreamProcessorDataSharingPreference"></a>

 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. 

## Contents
<a name="API_StreamProcessorDataSharingPreference_Contents"></a>

 ** OptIn **   <a name="rekognition-Type-StreamProcessorDataSharingPreference-OptIn"></a>
 If this option is set to true, you choose to share data with Rekognition to improve model performance.   
Type: Boolean  
Required: Yes

## See Also
<a name="API_StreamProcessorDataSharingPreference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorDataSharingPreference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorDataSharingPreference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorDataSharingPreference) 

# StreamProcessorInput
<a name="API_StreamProcessorInput"></a>

Information about the source streaming video. 

## Contents
<a name="API_StreamProcessorInput_Contents"></a>

 ** KinesisVideoStream **   <a name="rekognition-Type-StreamProcessorInput-KinesisVideoStream"></a>
The Kinesis video stream input stream for the source streaming video.  
Type: [KinesisVideoStream](API_KinesisVideoStream.md) object  
Required: No

## See Also
<a name="API_StreamProcessorInput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorInput) 

# StreamProcessorNotificationChannel
<a name="API_StreamProcessorNotificationChannel"></a>

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.

## Contents
<a name="API_StreamProcessorNotificationChannel_Contents"></a>

 ** SNSTopicArn **   <a name="rekognition-Type-StreamProcessorNotificationChannel-SNSTopicArn"></a>
 The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.   
Type: String  
Pattern: `(^arn:aws:sns:.*:\w{12}:.+$)`   
Required: Yes

## See Also
<a name="API_StreamProcessorNotificationChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorNotificationChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorNotificationChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorNotificationChannel) 

# StreamProcessorOutput
<a name="API_StreamProcessorOutput"></a>

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](API_CreateStreamProcessor.md).

## Contents
<a name="API_StreamProcessorOutput_Contents"></a>

 ** KinesisDataStream **   <a name="rekognition-Type-StreamProcessorOutput-KinesisDataStream"></a>
The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.  
Type: [KinesisDataStream](API_KinesisDataStream.md) object  
Required: No

 ** S3Destination **   <a name="rekognition-Type-StreamProcessorOutput-S3Destination"></a>
 The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.   
Type: [S3Destination](API_S3Destination.md) object  
Required: No

## See Also
<a name="API_StreamProcessorOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorOutput) 

# StreamProcessorSettings
<a name="API_StreamProcessorSettings"></a>

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. 

## Contents
<a name="API_StreamProcessorSettings_Contents"></a>

 ** ConnectedHome **   <a name="rekognition-Type-StreamProcessorSettings-ConnectedHome"></a>
 Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for [CreateStreamProcessor](API_CreateStreamProcessor.md). 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.   
Type: [ConnectedHomeSettings](API_ConnectedHomeSettings.md) object  
Required: No

 ** FaceSearch **   <a name="rekognition-Type-StreamProcessorSettings-FaceSearch"></a>
Face search settings to use on a streaming video.   
Type: [FaceSearchSettings](API_FaceSearchSettings.md) object  
Required: No

## See Also
<a name="API_StreamProcessorSettings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorSettings) 

# StreamProcessorSettingsForUpdate
<a name="API_StreamProcessorSettingsForUpdate"></a>

 The stream processor settings that you want to update. `ConnectedHome` settings can be updated to detect different labels with a different minimum confidence. 

## Contents
<a name="API_StreamProcessorSettingsForUpdate_Contents"></a>

 ** ConnectedHomeForUpdate **   <a name="rekognition-Type-StreamProcessorSettingsForUpdate-ConnectedHomeForUpdate"></a>
 The label detection settings you want to use for your stream processor.   
Type: [ConnectedHomeSettingsForUpdate](API_ConnectedHomeSettingsForUpdate.md) object  
Required: No

## See Also
<a name="API_StreamProcessorSettingsForUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/StreamProcessorSettingsForUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/StreamProcessorSettingsForUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/StreamProcessorSettingsForUpdate) 

# Summary
<a name="API_Summary"></a>

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](API_DescribeProjectVersions.md). 

## Contents
<a name="API_Summary_Contents"></a>

 ** S3Object **   <a name="rekognition-Type-Summary-S3Object"></a>
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](https://docs.aws.amazon.com/rekognition/latest/dg/security_iam_service-with-iam.html).   
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_Summary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Summary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Summary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Summary) 

# Sunglasses
<a name="API_Sunglasses"></a>

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

## Contents
<a name="API_Sunglasses_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-Sunglasses-Confidence"></a>
Level of confidence in the determination.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** Value **   <a name="rekognition-Type-Sunglasses-Value"></a>
Boolean value that indicates whether the face is wearing sunglasses or not.  
Type: Boolean  
Required: No

## See Also
<a name="API_Sunglasses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Sunglasses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Sunglasses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Sunglasses) 

# TechnicalCueSegment
<a name="API_TechnicalCueSegment"></a>

Information about a technical cue segment. For more information, see [SegmentDetection](API_SegmentDetection.md).

## Contents
<a name="API_TechnicalCueSegment_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-TechnicalCueSegment-Confidence"></a>
The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.  
Type: Float  
Valid Range: Minimum value of 50. Maximum value of 100.  
Required: No

 ** Type **   <a name="rekognition-Type-TechnicalCueSegment-Type"></a>
The type of the technical cue.  
Type: String  
Valid Values: `ColorBars | EndCredits | BlackFrames | OpeningCredits | StudioLogo | Slate | Content`   
Required: No

## See Also
<a name="API_TechnicalCueSegment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TechnicalCueSegment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TechnicalCueSegment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TechnicalCueSegment) 

# TestingData
<a name="API_TestingData"></a>

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. 

## Contents
<a name="API_TestingData_Contents"></a>

 ** Assets **   <a name="rekognition-Type-TestingData-Assets"></a>
The assets used for testing.  
Type: Array of [Asset](API_Asset.md) objects  
Required: No

 ** AutoCreate **   <a name="rekognition-Type-TestingData-AutoCreate"></a>
If specified, Rekognition splits training dataset to create a test dataset for the training job.  
Type: Boolean  
Required: No

## See Also
<a name="API_TestingData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TestingData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TestingData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TestingData) 

# TestingDataResult
<a name="API_TestingDataResult"></a>

Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

## Contents
<a name="API_TestingDataResult_Contents"></a>

 ** Input **   <a name="rekognition-Type-TestingDataResult-Input"></a>
The testing dataset that was supplied for training.  
Type: [TestingData](API_TestingData.md) object  
Required: No

 ** Output **   <a name="rekognition-Type-TestingDataResult-Output"></a>
The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.   
Type: [TestingData](API_TestingData.md) object  
Required: No

 ** Validation **   <a name="rekognition-Type-TestingDataResult-Validation"></a>
The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.  
Type: [ValidationData](API_ValidationData.md) object  
Required: No

## See Also
<a name="API_TestingDataResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TestingDataResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TestingDataResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TestingDataResult) 

# TextDetection
<a name="API_TextDetection"></a>

Information about a word or line of text detected by [DetectText](API_DetectText.md).

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](https://docs.aws.amazon.com/rekognition/latest/dg/text-detection.html).

## Contents
<a name="API_TextDetection_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-TextDetection-Confidence"></a>
The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** DetectedText **   <a name="rekognition-Type-TextDetection-DetectedText"></a>
The word or line of text recognized by Amazon Rekognition.   
Type: String  
Required: No

 ** Geometry **   <a name="rekognition-Type-TextDetection-Geometry"></a>
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.  
Type: [Geometry](API_Geometry.md) object  
Required: No

 ** Id **   <a name="rekognition-Type-TextDetection-Id"></a>
The identifier for the detected text. The identifier is only unique for a single call to `DetectText`.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** ParentId **   <a name="rekognition-Type-TextDetection-ParentId"></a>
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`.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Type **   <a name="rekognition-Type-TextDetection-Type"></a>
The type of text that was detected.  
Type: String  
Valid Values: `LINE | WORD`   
Required: No

## See Also
<a name="API_TextDetection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TextDetection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TextDetection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TextDetection) 

# TextDetectionResult
<a name="API_TextDetectionResult"></a>

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.

## Contents
<a name="API_TextDetectionResult_Contents"></a>

 ** TextDetection **   <a name="rekognition-Type-TextDetectionResult-TextDetection"></a>
Details about text detected in a video.  
Type: [TextDetection](API_TextDetection.md) object  
Required: No

 ** Timestamp **   <a name="rekognition-Type-TextDetectionResult-Timestamp"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_TextDetectionResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TextDetectionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TextDetectionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TextDetectionResult) 

# TrainingData
<a name="API_TrainingData"></a>

The dataset used for training.

## Contents
<a name="API_TrainingData_Contents"></a>

 ** Assets **   <a name="rekognition-Type-TrainingData-Assets"></a>
A manifest file that contains references to the training images and ground-truth annotations.  
Type: Array of [Asset](API_Asset.md) objects  
Required: No

## See Also
<a name="API_TrainingData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TrainingData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TrainingData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TrainingData) 

# TrainingDataResult
<a name="API_TrainingDataResult"></a>

The data validation manifest created for the training dataset during model training.

## Contents
<a name="API_TrainingDataResult_Contents"></a>

 ** Input **   <a name="rekognition-Type-TrainingDataResult-Input"></a>
The training data that you supplied.  
Type: [TrainingData](API_TrainingData.md) object  
Required: No

 ** Output **   <a name="rekognition-Type-TrainingDataResult-Output"></a>
Reference to images (assets) that were actually used during training with trained model predictions.  
Type: [TrainingData](API_TrainingData.md) object  
Required: No

 ** Validation **   <a name="rekognition-Type-TrainingDataResult-Validation"></a>
A manifest that you supplied for training, with validation results for each line.  
Type: [ValidationData](API_ValidationData.md) object  
Required: No

## See Also
<a name="API_TrainingDataResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/TrainingDataResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/TrainingDataResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/TrainingDataResult) 

# UnindexedFace
<a name="API_UnindexedFace"></a>

A face that [IndexFaces](API_IndexFaces.md) detected, but didn't index. Use the `Reasons` response attribute to determine why a face wasn't indexed.

## Contents
<a name="API_UnindexedFace_Contents"></a>

 ** FaceDetail **   <a name="rekognition-Type-UnindexedFace-FaceDetail"></a>
The structure that contains attributes of a face that `IndexFaces`detected, but didn't index.   
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

 ** Reasons **   <a name="rekognition-Type-UnindexedFace-Reasons"></a>
An array of reasons that specify why a face wasn't indexed.   
+ EXTREME\$1POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.
+ EXCEEDS\$1MAX\$1FACES - The number of faces detected is already higher than that specified by the `MaxFaces` input parameter for `IndexFaces`.
+ LOW\$1BRIGHTNESS - The image is too dark.
+ LOW\$1SHARPNESS - The image is too blurry.
+ LOW\$1CONFIDENCE - The face was detected with a low confidence.
+ SMALL\$1BOUNDING\$1BOX - The bounding box around the face is too small.
Type: Array of strings  
Valid Values: `EXCEEDS_MAX_FACES | EXTREME_POSE | LOW_BRIGHTNESS | LOW_SHARPNESS | LOW_CONFIDENCE | SMALL_BOUNDING_BOX | LOW_FACE_QUALITY`   
Required: No

## See Also
<a name="API_UnindexedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UnindexedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UnindexedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UnindexedFace) 

# UnsearchedFace
<a name="API_UnsearchedFace"></a>

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. 

## Contents
<a name="API_UnsearchedFace_Contents"></a>

 ** FaceDetails **   <a name="rekognition-Type-UnsearchedFace-FaceDetails"></a>
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](API_GetFaceDetection.md) 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](API_StartFaceDetection.md). 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](API_DetectFaces.md) and [IndexFaces](API_IndexFaces.md) 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.  
Type: [FaceDetail](API_FaceDetail.md) object  
Required: No

 ** Reasons **   <a name="rekognition-Type-UnsearchedFace-Reasons"></a>
 Reasons why a face wasn't used for Search.   
Type: Array of strings  
Valid Values: `FACE_NOT_LARGEST | EXCEEDS_MAX_FACES | EXTREME_POSE | LOW_BRIGHTNESS | LOW_SHARPNESS | LOW_CONFIDENCE | SMALL_BOUNDING_BOX | LOW_FACE_QUALITY`   
Required: No

## See Also
<a name="API_UnsearchedFace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UnsearchedFace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UnsearchedFace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UnsearchedFace) 

# UnsuccessfulFaceAssociation
<a name="API_UnsuccessfulFaceAssociation"></a>

Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.

## Contents
<a name="API_UnsuccessfulFaceAssociation_Contents"></a>

 ** Confidence **   <a name="rekognition-Type-UnsuccessfulFaceAssociation-Confidence"></a>
Match confidence with the UserID, provides information regarding if a face association was unsuccessful because it didn't meet UserMatchThreshold.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** FaceId **   <a name="rekognition-Type-UnsuccessfulFaceAssociation-FaceId"></a>
A unique identifier assigned to the face.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** Reasons **   <a name="rekognition-Type-UnsuccessfulFaceAssociation-Reasons"></a>
 The reason why the association was unsuccessful.   
Type: Array of strings  
Valid Values: `FACE_NOT_FOUND | ASSOCIATED_TO_A_DIFFERENT_USER | LOW_MATCH_CONFIDENCE`   
Required: No

 ** UserId **   <a name="rekognition-Type-UnsuccessfulFaceAssociation-UserId"></a>
A provided ID for the UserID. Unique within the collection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

## See Also
<a name="API_UnsuccessfulFaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UnsuccessfulFaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UnsuccessfulFaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UnsuccessfulFaceAssociation) 

# UnsuccessfulFaceDeletion
<a name="API_UnsuccessfulFaceDeletion"></a>

Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.

## Contents
<a name="API_UnsuccessfulFaceDeletion_Contents"></a>

 ** FaceId **   <a name="rekognition-Type-UnsuccessfulFaceDeletion-FaceId"></a>
 A unique identifier assigned to the face.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** Reasons **   <a name="rekognition-Type-UnsuccessfulFaceDeletion-Reasons"></a>
The reason why the deletion was unsuccessful.   
Type: Array of strings  
Valid Values: `ASSOCIATED_TO_AN_EXISTING_USER | FACE_NOT_FOUND`   
Required: No

 ** UserId **   <a name="rekognition-Type-UnsuccessfulFaceDeletion-UserId"></a>
 A provided ID for the UserID. Unique within the collection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

## See Also
<a name="API_UnsuccessfulFaceDeletion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UnsuccessfulFaceDeletion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UnsuccessfulFaceDeletion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UnsuccessfulFaceDeletion) 

# UnsuccessfulFaceDisassociation
<a name="API_UnsuccessfulFaceDisassociation"></a>

Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.

## Contents
<a name="API_UnsuccessfulFaceDisassociation_Contents"></a>

 ** FaceId **   <a name="rekognition-Type-UnsuccessfulFaceDisassociation-FaceId"></a>
A unique identifier assigned to the face.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** Reasons **   <a name="rekognition-Type-UnsuccessfulFaceDisassociation-Reasons"></a>
The reason why the deletion was unsuccessful.   
Type: Array of strings  
Valid Values: `FACE_NOT_FOUND | ASSOCIATED_TO_A_DIFFERENT_USER`   
Required: No

 ** UserId **   <a name="rekognition-Type-UnsuccessfulFaceDisassociation-UserId"></a>
A provided ID for the UserID. Unique within the collection.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

## See Also
<a name="API_UnsuccessfulFaceDisassociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UnsuccessfulFaceDisassociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UnsuccessfulFaceDisassociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UnsuccessfulFaceDisassociation) 

# User
<a name="API_User"></a>

Metadata of the user stored in a collection.

## Contents
<a name="API_User_Contents"></a>

 ** UserId **   <a name="rekognition-Type-User-UserId"></a>
 A provided ID for the User. Unique within the collection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9_.\-:]+`   
Required: No

 ** UserStatus **   <a name="rekognition-Type-User-UserStatus"></a>
 Communicates if the UserID has been updated with latest set of faces to be associated with the UserID.   
Type: String  
Valid Values: `ACTIVE | UPDATING | CREATING | CREATED`   
Required: No

## See Also
<a name="API_User_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/User) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/User) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/User) 

# UserMatch
<a name="API_UserMatch"></a>

Provides UserID metadata along with the confidence in the match of this UserID with the input face.

## Contents
<a name="API_UserMatch_Contents"></a>

 ** Similarity **   <a name="rekognition-Type-UserMatch-Similarity"></a>
 Describes the UserID metadata.  
Type: Float  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** User **   <a name="rekognition-Type-UserMatch-User"></a>
 Confidence in the match of this UserID with the input face.   
Type: [MatchedUser](API_MatchedUser.md) object  
Required: No

## See Also
<a name="API_UserMatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/UserMatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/UserMatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/UserMatch) 

# ValidationData
<a name="API_ValidationData"></a>

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](https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/tm-debugging.html). 

You get the `ValidationData` object for the training dataset ([TrainingDataResult](API_TrainingDataResult.md)) and the test dataset ([TestingDataResult](API_TestingDataResult.md)) by calling [DescribeProjectVersions](API_DescribeProjectVersions.md). 

The assets array contains a single [Asset](API_Asset.md) object. The [GroundTruthManifest](API_GroundTruthManifest.md) field of the Asset object contains the S3 bucket location of the validation data. 

## Contents
<a name="API_ValidationData_Contents"></a>

 ** Assets **   <a name="rekognition-Type-ValidationData-Assets"></a>
The assets that comprise the validation data.   
Type: Array of [Asset](API_Asset.md) objects  
Required: No

## See Also
<a name="API_ValidationData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ValidationData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ValidationData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ValidationData) 

# Versions
<a name="API_Versions"></a>

Object specifying the acceptable range of challenge versions.

## Contents
<a name="API_Versions_Contents"></a>

 ** Maximum **   <a name="rekognition-Type-Versions-Maximum"></a>
The desired maximum version for the challenge.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 11.  
Pattern: `^(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})$`   
Required: No

 ** Minimum **   <a name="rekognition-Type-Versions-Minimum"></a>
The desired minimum version for the challenge.  
Type: String  
Length Constraints: Minimum length of 5. Maximum length of 11.  
Pattern: `^(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})$`   
Required: No

## See Also
<a name="API_Versions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Versions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Versions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Versions) 

# Video
<a name="API_Video"></a>

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as [StartLabelDetection](API_StartLabelDetection.md) use `Video` to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

## Contents
<a name="API_Video_Contents"></a>

 ** S3Object **   <a name="rekognition-Type-Video-S3Object"></a>
The Amazon S3 bucket name and file name for the video.  
Type: [S3Object](API_S3Object.md) object  
Required: No

## See Also
<a name="API_Video_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/Video) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/Video) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/Video) 

# VideoMetadata
<a name="API_VideoMetadata"></a>

Information about a video that Amazon Rekognition analyzed. `Videometadata` is returned in every page of paginated responses from a Amazon Rekognition video operation.

## Contents
<a name="API_VideoMetadata_Contents"></a>

 ** Codec **   <a name="rekognition-Type-VideoMetadata-Codec"></a>
Type of compression used in the analyzed video.   
Type: String  
Required: No

 ** ColorRange **   <a name="rekognition-Type-VideoMetadata-ColorRange"></a>
 A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).   
Type: String  
Valid Values: `FULL | LIMITED`   
Required: No

 ** DurationMillis **   <a name="rekognition-Type-VideoMetadata-DurationMillis"></a>
Length of the video in milliseconds.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** Format **   <a name="rekognition-Type-VideoMetadata-Format"></a>
Format of the analyzed video. Possible values are MP4, MOV and AVI.   
Type: String  
Required: No

 ** FrameHeight **   <a name="rekognition-Type-VideoMetadata-FrameHeight"></a>
Vertical pixel dimension of the video.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** FrameRate **   <a name="rekognition-Type-VideoMetadata-FrameRate"></a>
Number of frames per second in the video.  
Type: Float  
Required: No

 ** FrameWidth **   <a name="rekognition-Type-VideoMetadata-FrameWidth"></a>
Horizontal pixel dimension of the video.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_VideoMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/VideoMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/VideoMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/VideoMetadata)