GroundTruthManifest groundTruthManifest
String codec
The audio codec used to encode or decode the audio stream.
Long durationMillis
The duration of the audio stream in milliseconds.
Long sampleRate
The sample rate for the audio stream.
Long numberOfChannels
The number of audio channels in the segment.
Float width
Width of the bounding box as a ratio of the overall image width.
Float height
Height of the bounding box as a ratio of the overall image height.
Float left
Left coordinate of the bounding box as a ratio of overall image width.
Float top
Top coordinate of the bounding box as a ratio of overall image height.
List<E> urls
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
String name
The name of the celebrity.
String id
A unique identifier for the celebrity.
ComparedFace face
Provides information about the celebrity's face, such as its location on the image.
Float matchConfidence
The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
List<E> urls
An array of URLs pointing to additional celebrity information.
String name
The name of the celebrity.
String id
The unique identifier for the celebrity.
Float confidence
The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.
BoundingBox boundingBox
Bounding box around the body of a celebrity.
FaceDetail face
Face details for the recognized celebrity.
Long timestamp
The time, in milliseconds from the start of the video, that the celebrity was recognized.
CelebrityDetail celebrity
Information about a recognized celebrity.
BoundingBox boundingBox
Bounding box of the face.
Float confidence
Level of confidence that what the bounding box contains is a face.
List<E> landmarks
An array of facial landmarks.
Pose pose
Indicates the pose of the face as determined by its pitch, roll, and yaw.
ImageQuality quality
Identifies face image brightness and sharpness.
BoundingBox boundingBox
Bounding box of the face.
Float confidence
Confidence level that the selected bounding box contains a face.
Float similarity
Level of confidence that the faces match.
ComparedFace face
Provides face metadata (bounding box and confidence that the bounding box actually contains a face).
Image sourceImage
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
Image targetImage
The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
Float similarityThreshold
The minimum level of confidence in the face matches that a match must meet to be included in the
FaceMatches array.
String qualityFilter
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't
compared. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify
LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the
chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur
for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or
a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The
default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
ComparedSourceImageFace sourceImageFace
The face in the source image that was used for comparison.
List<E> faceMatches
An array of faces in the target image that match the source image face. Each CompareFacesMatch
object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity
score for the face in the bounding box and the face in the source image.
List<E> unmatchedFaces
An array of faces in the target image that did not match the source image face.
String sourceImageOrientationCorrection
The value of SourceImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
String targetImageOrientationCorrection
The value of TargetImageOrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Long timestamp
Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.
ModerationLabel moderationLabel
The unsafe content label detected by in the stored video.
Integer statusCode
HTTP status code indicating the result of the operation.
String collectionArn
Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.
String faceModelVersion
Version number of the face detection model associated with the collection you are creating.
String projectName
The name of the project to create.
String projectArn
The Amazon Resource Name (ARN) of the new project. You can use the ARN to configure IAM access to the project.
String projectArn
The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
String versionName
A name for the version of the model. This value must be unique.
OutputConfig outputConfig
The Amazon S3 location to store the results of training.
TrainingData trainingData
The dataset to use for training.
TestingData testingData
The dataset to use for testing.
Map<K,V> tags
A set of tags (key-value pairs) that you want to attach to the model.
String projectVersionArn
The ARN of the model version that was created. Use DescribeProjectVersion to get the current status
of the training operation.
StreamProcessorInput input
Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter
name is StreamProcessorInput.
StreamProcessorOutput output
Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS
CLI, the parameter name is StreamProcessorOutput.
String name
An identifier you assign to the stream processor. You can use Name to manage the stream processor.
For example, you can get the current status of the stream processor by calling DescribeStreamProcessor.
Name is idempotent.
StreamProcessorSettings settings
Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
String roleArn
ARN of the IAM role that allows access to the stream processor.
Map<K,V> tags
A set of tags (key-value pairs) that you want to attach to the stream processor.
String streamProcessorArn
ARN for the newly create stream processor.
String name
The name of the custom label.
Float confidence
The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.
Geometry geometry
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.
String collectionId
ID of the collection to delete.
Integer statusCode
HTTP status code that indicates the result of the operation.
String projectArn
The Amazon Resource Name (ARN) of the project that you want to delete.
String status
The current status of the delete project operation.
String projectVersionArn
The Amazon Resource Name (ARN) of the model version that you want to delete.
String status
The status of the deletion operation.
String name
The name of the stream processor you want to delete.
String collectionId
The ID of the collection to describe.
Long faceCount
The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.
String faceModelVersion
The version of the face model that's used by the collection for face detection.
For more information, see Model Versioning in the Amazon Rekognition Developer Guide.
String collectionARN
The Amazon Resource Name (ARN) of the collection.
Date creationTimestamp
The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
String nextToken
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
List<E> projectDescriptions
A list of project descriptions. The list is sorted by the date and time the projects are created.
String nextToken
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
String projectArn
The Amazon Resource Name (ARN) of the project that contains the models you want to describe.
List<E> versionNames
A list of model version names that you want to describe. You can add up to 10 model version names to the list. If
you don't specify a value, all model descriptions are returned. A version name is part of a model
(ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following
ARN.
arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123
.
String nextToken
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
Integer maxResults
The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
List<E> projectVersionDescriptions
A list of model descriptions. The list is sorted by the creation date and time of the model versions, latest to earliest.
String nextToken
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
String name
Name of the stream processor for which you want information.
String name
Name of the stream processor.
String streamProcessorArn
ARN of the stream processor.
String status
Current status of the stream processor.
String statusMessage
Detailed status message about the stream processor.
Date creationTimestamp
Date and time the stream processor was created
Date lastUpdateTimestamp
The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.
StreamProcessorInput input
Kinesis video stream that provides the source streaming video.
StreamProcessorOutput output
Kinesis data stream to which Amazon Rekognition Video puts the analysis results.
String roleArn
ARN of the IAM role that allows access to the stream processor.
StreamProcessorSettings settings
Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.
String projectVersionArn
The ARN of the model version that you want to use.
Image image
Integer maxResults
Maximum number of results you want the service to return in the response. The service returns the specified number of highest confidence labels ranked from highest confidence to lowest.
Float minConfidence
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
List<E> attributes
An array of facial attributes you want to be returned. This can be the default list of attributes or all
attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"],
the API returns the following subset of facial attributes: BoundingBox, Confidence,
Pose, Quality, and Landmarks. If you provide ["ALL"], all
facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which
attributes to return (in this case, all attributes).
List<E> faceDetails
Details of each face found in the image.
String orientationCorrection
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Float minConfidence
Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.
Float minBoundingBoxHeight
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.
Float minBoundingBoxWidth
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.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
Integer maxLabels
Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.
Float minConfidence
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.
If MinConfidence is not specified, the operation returns labels with a confidence values greater
than or equal to 55 percent.
List<E> labels
An array of labels for the real-world objects detected.
String orientationCorrection
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
String labelModelVersion
Version number of the label detection model that was used to detect labels.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
Float minConfidence
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.
If you don't specify MinConfidence, the operation returns labels with confidence values greater than
or equal to 50 percent.
HumanLoopConfig humanLoopConfig
Sets up the configuration for human evaluation, including the FlowDefinition the image will be sent to.
List<E> moderationLabels
Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.
String moderationModelVersion
Version number of the moderation detection model that was used to detect unsafe content.
HumanLoopActivationOutput humanLoopActivationOutput
Shows the results of the human in the loop evaluation.
Image image
The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can reference an image stored in an Amazon S3 bucket.
ProtectiveEquipmentSummarizationAttributes summarizationAttributes
An array of PPE types that you want to summarize.
String protectiveEquipmentModelVersion
The version number of the PPE detection model used to detect PPE in the image.
List<E> persons
An array of persons detected in the image (including persons not wearing PPE).
ProtectiveEquipmentSummary summary
Summary information for the types of PPE specified in the SummarizationAttributes input parameter.
DetectionFilter wordFilter
List<E> regionsOfInterest
A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the
image.
Image image
The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
DetectTextFilters filters
Optional parameters that let you set the criteria that the text must meet to be included in your response.
BoundingBox boundingBox
A bounding box surrounding the item of detected PPE.
Float confidence
The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of
PPE.
String type
The type of detected PPE.
CoversBodyPart coversBodyPart
Information about the body part covered by the detected PPE.
Float f1Score
The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision and recall performance of the model as a single value. A higher value indicates better precision and recall performance. A lower score indicates that precision, recall, or both are performing poorly.
Summary summary
The S3 bucket that contains the training summary.
String faceId
Unique identifier that Amazon Rekognition assigns to the face.
BoundingBox boundingBox
Bounding box of the face.
String imageId
Unique identifier that Amazon Rekognition assigns to the input image.
String externalImageId
Identifier that you assign to all the faces in the input image.
Float confidence
Confidence level that the bounding box contains a face (and not a different object such as a tree).
BoundingBox boundingBox
Bounding box of the face. Default attribute.
AgeRange ageRange
The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.
Smile smile
Indicates whether or not the face is smiling, and the confidence level in the determination.
Eyeglasses eyeglasses
Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.
Sunglasses sunglasses
Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.
Gender gender
The predicted gender of a detected face.
Beard beard
Indicates whether or not the face has a beard, and the confidence level in the determination.
Mustache mustache
Indicates whether or not the face has a mustache, and the confidence level in the determination.
EyeOpen eyesOpen
Indicates whether or not the eyes on the face are open, and the confidence level in the determination.
MouthOpen mouthOpen
Indicates whether or not the mouth on the face is open, and the confidence level in the determination.
List<E> emotions
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.
List<E> landmarks
Indicates the location of landmarks on the face. Default attribute.
Pose pose
Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.
ImageQuality quality
Identifies image brightness and sharpness. Default attribute.
Float confidence
Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.
Long timestamp
Time, in milliseconds from the start of the video, that the face was detected.
FaceDetail face
The face properties for the detected face.
Face face
Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.
FaceDetail faceDetail
Structure containing attributes of the face that the algorithm detected.
String collectionId
The ID of a collection that contains faces that you want to search for.
Float faceMatchThreshold
Minimum face match confidence score that must be met to return a result for a recognized face. Default is 80. 0 is the lowest confidence. 100 is the highest confidence.
BoundingBox boundingBox
An axis-aligned coarse representation of the detected item's location on the image.
List<E> polygon
Within the bounding box, a fine-grained polygon around the detected item.
String id
The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.
String jobId
Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to
StartCelebrityRecognition.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
String sortBy
Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the
celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.
String jobStatus
The current status of the celebrity recognition job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every
page of paginated responses from a Amazon Rekognition Video operation.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
List<E> celebrities
Array of celebrities recognized in the video.
String jobId
The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to
GetContentModeration.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of unsafe content labels.
String sortBy
Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort
array elements by the time labels are detected. Use NAME to alphabetically group elements for a
label together. Within each label group, the array element are sorted by detection confidence. The default sort
is by TIMESTAMP.
String jobStatus
The current status of the unsafe content analysis job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page
of paginated responses from GetContentModeration.
List<E> moderationLabels
The detected unsafe content labels and the time(s) they were detected.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of unsafe content labels.
String moderationModelVersion
Version number of the moderation detection model that was used to detect unsafe content.
String jobId
Unique identifier for the face detection job. The JobId is returned from
StartFaceDetection.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
String jobStatus
The current status of the face detection job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every
page of paginated responses from a Amazon Rekognition video operation.
String nextToken
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
List<E> faces
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
String jobId
The job identifer for the search request. You get the job identifier from an initial call to
StartFaceSearch.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.
String sortBy
Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they
are recognized. Use INDEX to sort by recognized faces.
String jobStatus
The current status of the face search job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page
of paginated responses from a Amazon Rekognition Video operation.
List<E> persons
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition
collection. It also includes time information for when persons are matched in the video. You specify the input
collection in an initial call to StartFaceSearch. Each Persons element includes a time
the person was matched, face match details (FaceMatches) for matching faces in the collection, and
person information (Person) for the matched person.
String jobId
Job identifier for the label detection operation for which you want results returned. You get the job identifer
from an initial call to StartlabelDetection.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
String sortBy
Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by
the time labels are detected. Use NAME to alphabetically group elements for a label together. Within
each label group, the array element are sorted by detection confidence. The default sort is by
TIMESTAMP.
String jobStatus
The current status of the label detection job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every
page of paginated responses from a Amazon Rekognition video operation.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
List<E> labels
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
String labelModelVersion
Version number of the label detection model that was used to detect labels.
String jobId
The identifier for a job that tracks persons in a video. You get the JobId from a call to
StartPersonTracking.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
String nextToken
If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
String sortBy
Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by
the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by
INDEX, the array elements for each person are sorted by detection confidence. The default sort is by
TIMESTAMP.
String jobStatus
The current status of the person tracking job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every
page of paginated responses from a Amazon Rekognition Video operation.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
List<E> persons
An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.
String jobId
Job identifier for the text detection operation for which you want results returned. You get the job identifer
from an initial call to StartSegmentDetection.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
String jobStatus
Current status of the segment detection job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
List<E> videoMetadata
Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object
contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The
VideoMetadata object includes the video codec, video format and other information. Video metadata is
returned in each page of information returned by GetSegmentDetection.
List<E> audioMetadata
An array of objects. There can be multiple audio streams. Each AudioMetadata object contains
metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio
codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is
returned in each page of information returned by GetSegmentDetection.
String nextToken
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
List<E> segments
An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT)
specified in the SegmentTypes input parameter of StartSegmentDetection. Within each
segment type the array is sorted by timestamp values.
List<E> selectedSegmentTypes
An array containing the segment types requested in the call to StartSegmentDetection.
String jobId
Job identifier for the text detection operation for which you want results returned. You get the job identifer
from an initial call to StartTextDetection.
Integer maxResults
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
String nextToken
If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
String jobStatus
Current status of the text detection job.
String statusMessage
If the job fails, StatusMessage provides a descriptive error message.
VideoMetadata videoMetadata
List<E> textDetections
An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.
String nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.
String textModelVersion
Version number of the text detection model that was used to detect text.
S3Object s3Object
String humanLoopArn
The Amazon Resource Name (ARN) of the HumanLoop created.
List<E> humanLoopActivationReasons
Shows if and why human review was needed.
String humanLoopActivationConditionsEvaluationResults
Shows the result of condition evaluations, including those conditions which activated a human review.
String humanLoopName
The name of the human review used for this image. This should be kept unique within a region.
String flowDefinitionArn
The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by using the Amazon Sagemaker CreateFlowDefinition Operation.
HumanLoopDataAttributes dataAttributes
Sets attributes of the input data.
ByteBuffer bytes
Blob of image bytes up to 5 MBs.
S3Object s3Object
Identifies an S3 object as the image source.
Float brightness
Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.
Float sharpness
Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.
String collectionId
The ID of an existing collection to which you want to add the faces that are detected in the input images.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
String externalImageId
The ID you want to assign to all the faces detected in the image.
List<E> detectionAttributes
An array of facial attributes that you want to be returned. This can be the default list of attributes or all
attributes. If you don't specify a value for Attributes or if you specify ["DEFAULT"],
the API returns the following subset of facial attributes: BoundingBox, Confidence,
Pose, Quality, and Landmarks. If you provide ["ALL"], all
facial attributes are returned, but the operation takes longer to complete.
If you provide both, ["ALL", "DEFAULT"], the service uses a logical AND operator to determine which
attributes to return (in this case, all attributes).
Integer maxFaces
The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1.
IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value
for MaxFaces.
If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest
quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces
with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of
MaxFaces). Information about the unindexed faces is available in the UnindexedFaces
array.
The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the
smallest size, in descending order.
MaxFaces can be used with a collection associated with any version of the face model.
String qualityFilter
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't
indexed. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify
LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the
chosen quality bar. The default value is AUTO. The quality bar is based on a variety of common use
cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified
as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify
NONE, no filtering is performed.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
List<E> faceRecords
An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.
String orientationCorrection
If your collection is associated with a face detection model that's later than version 3.0, the value of
OrientationCorrection is always null and no orientation information is returned.
If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that
includes the image's orientation. Amazon Rekognition uses this orientation information to perform image
correction - the bounding box coordinates are translated to represent object locations after the orientation
information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain
Exif metadata. The value of OrientationCorrection is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords array. You can get the version of the face
detection model by calling DescribeCollection.
String faceModelVersion
The version number of the face detection model that's associated with the input collection (
CollectionId).
List<E> unindexedFaces
An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality
filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use
the quality filter, you specify the QualityFilter request parameter.
BoundingBox boundingBox
The position of the label instance on the image.
Float confidence
The confidence that Amazon Rekognition has in the accuracy of the bounding box.
String arn
ARN of the output Amazon Kinesis Data Streams stream.
String arn
ARN of the Kinesis video stream stream that streams the source video.
String name
The name (label) of the object or scene.
Float confidence
Level of confidence.
List<E> instances
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.
List<E> parents
The parent labels for a label. The response includes all ancestor labels.
String type
Type of landmark.
Float x
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.
Float y
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.
List<E> collectionIds
An array of collection IDs.
String nextToken
If the result is truncated, the response provides a NextToken that you can use in the subsequent
request to fetch the next set of collection IDs.
List<E> faceModelVersions
Version numbers of the face detection models associated with the collections in the array
CollectionIds. For example, the value of FaceModelVersions[2] is the version number for
the face detection model used by the collection in CollectionId[2].
String collectionId
ID of the collection from which to list the faces.
String nextToken
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
Integer maxResults
Maximum number of faces to return.
List<E> faces
An array of Face objects.
String nextToken
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
String faceModelVersion
Version number of the face detection model associated with the input collection (CollectionId).
String nextToken
If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.
Integer maxResults
Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.
String resourceArn
Amazon Resource Name (ARN) of the model, collection, or stream processor that contains the tags that you want a list of.
Float confidence
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.
String name
The label name for the type of unsafe content detected in the image.
String parentName
The name for the parent label. Labels at the top level of the hierarchy have the parent label "".
String name
The name of the parent label.
Long index
Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.
BoundingBox boundingBox
Bounding box around the detected person.
FaceDetail face
Face details for the detected person.
Long timestamp
The time, in milliseconds from the start of the video, that the person's path was tracked.
PersonDetail person
Details about a person whose path was tracked in a video.
Long timestamp
The time, in milliseconds from the beginning of the video, that the person was matched in the video.
PersonDetail person
Information about the matched person.
List<E> faceMatches
Information about the faces in the input collection that match the face of a person in the video.
String projectVersionArn
The Amazon Resource Name (ARN) of the model version.
Date creationTimestamp
The Unix datetime for the date and time that training started.
Integer minInferenceUnits
The minimum number of inference units used by the model. For more information, see StartProjectVersion.
String status
The current status of the model version.
String statusMessage
A descriptive message for an error or warning that occurred.
Long billableTrainingTimeInSeconds
The duration, in seconds, that the model version has been billed for training. This value is only returned if the model version has been successfully trained.
Date trainingEndTimestamp
The Unix date and time that training of the model ended.
OutputConfig outputConfig
The location where training results are saved.
TrainingDataResult trainingDataResult
Contains information about the training results.
TestingDataResult testingDataResult
Contains information about the testing results.
EvaluationResult evaluationResult
The training results. EvaluationResult is only returned if training is successful.
GroundTruthManifest manifestSummary
The location of the summary manifest. The summary manifest provides aggregate data validation results for the training and test datasets.
List<E> bodyParts
An array of body parts detected on a person's body (including body parts without PPE).
BoundingBox boundingBox
A bounding box around the detected person.
Float confidence
The confidence that Amazon Rekognition has that the bounding box contains a person.
Integer id
The identifier for the detected person. The identifier is only unique for a single call to
DetectProtectiveEquipment.
Float minConfidence
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%.
List<E> requiredEquipmentTypes
An array of personal protective equipment types for which you want summary information. If a person is detected
wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment
array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.
List<E> personsWithRequiredEquipment
An array of IDs for persons who are wearing detected personal protective equipment.
List<E> personsWithoutRequiredEquipment
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.
List<E> personsIndeterminate
An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
List<E> celebrityFaces
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image.
List<E> unrecognizedFaces
Details about each unrecognized face in the image.
String orientationCorrection
The orientation of the input image (counterclockwise direction). If your application displays the image, you can
use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the
image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value
of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces
bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation.
Images in .png format don't contain Exif metadata.
BoundingBox boundingBox
The box representing a region of interest on screen.
String collectionId
ID of the collection to search.
Image image
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed
using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.
Integer maxFaces
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
Float faceMatchThreshold
(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
String qualityFilter
A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't
searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If
you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t
meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections
can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too
blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is
performed. The default value is NONE.
To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.
BoundingBox searchedFaceBoundingBox
The bounding box around the face in the input image that Amazon Rekognition used for the search.
Float searchedFaceConfidence
The level of confidence that the searchedFaceBoundingBox, contains a face.
List<E> faceMatches
An array of faces that match the input face, along with the confidence in the match.
String faceModelVersion
Version number of the face detection model associated with the input collection (CollectionId).
String collectionId
ID of the collection the face belongs to.
String faceId
ID of a face to find matches for in the collection.
Integer maxFaces
Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.
Float faceMatchThreshold
Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
String searchedFaceId
ID of the face that was searched for matches in a collection.
List<E> faceMatches
An array of faces that matched the input face, along with the confidence in the match.
String faceModelVersion
Version number of the face detection model associated with the input collection (CollectionId).
String type
The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
Long startTimestampMillis
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.
Long endTimestampMillis
The end time of the detected segment, in milliseconds, from the start of the video. This value is rounded down.
Long durationMillis
The duration of the detected segment in milliseconds.
String startTimecodeSMPTE
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).
String endTimecodeSMPTE
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).
String durationSMPTE
The duration of the timecode for the detected segment in SMPTE format.
TechnicalCueSegment technicalCueSegment
If the segment is a technical cue, contains information about the technical cue.
ShotSegment shotSegment
If the segment is a shot detection, contains information about the shot detection.
Video video
The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartCelebrityRecognition requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
NotificationChannel notificationChannel
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a
subsequent call to GetCelebrityRecognition.
Video video
The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.
Float minConfidence
Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label.
Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is
the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content
labels with a confidence level lower than this specified value. If you don't specify MinConfidence,
GetContentModeration returns labels with confidence values greater than or equal to 50 percent.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartContentModeration requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
NotificationChannel notificationChannel
The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the unsafe content analysis to.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the unsafe content analysis job. Use JobId to identify the job in a subsequent
call to GetContentModeration.
Video video
The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartFaceDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
NotificationChannel notificationChannel
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.
String faceAttributes
The face attributes you want returned.
DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose,
Quality and Landmarks.
ALL - All facial attributes are returned.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the face detection job. Use JobId to identify the job in a subsequent call to
GetFaceDetection.
Video video
The video you want to search. The video must be stored in an Amazon S3 bucket.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartFaceSearch requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
Float faceMatchThreshold
The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
String collectionId
ID of the collection that contains the faces you want to search for.
NotificationChannel notificationChannel
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the search job. Use JobId to identify the job in a subsequent call to
GetFaceSearch.
Video video
The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartLabelDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
Float minConfidence
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.
If you don't specify MinConfidence, the operation returns labels with confidence values greater than
or equal to 50 percent.
NotificationChannel notificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the label detection job. Use JobId to identify the job in a subsequent call to
GetLabelDetection.
Video video
The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartPersonTracking requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
NotificationChannel notificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
String jobId
The identifier for the person detection job. Use JobId to identify the job in a subsequent call to
GetPersonTracking.
String projectVersionArn
The Amazon Resource Name(ARN) of the model version that you want to start.
Integer minInferenceUnits
The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
String status
The current running status of the model.
StartTechnicalCueDetectionFilter technicalCueFilter
Filters that are specific to technical cues.
StartShotDetectionFilter shotFilter
Filters that are specific to shot detections.
Video video
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartSegmentDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidently started more than once.
NotificationChannel notificationChannel
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.
String jobTag
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple
Notification Service topic. For example, you can use JobTag to group related jobs and identify them
in the completion notification.
StartSegmentDetectionFilters filters
Filters for technical cue or shot detection.
List<E> segmentTypes
An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
String jobId
Unique identifier for the segment detection job. The JobId is returned from
StartSegmentDetection.
Float minSegmentConfidence
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.
String name
The name of the stream processor to start processing.
Float minSegmentConfidence
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.
DetectionFilter wordFilter
Filters focusing on qualities of the text, such as confidence or size.
List<E> regionsOfInterest
Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the
screen.
Video video
String clientRequestToken
Idempotent token used to identify the start request. If you use the same token with multiple
StartTextDetection requests, the same JobId is returned. Use
ClientRequestToken to prevent the same job from being accidentaly started more than once.
NotificationChannel notificationChannel
String jobTag
An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For
example, you can use JobTag to group related jobs and identify them in the completion notification.
StartTextDetectionFilters filters
Optional parameters that let you set criteria the text must meet to be included in your response.
String jobId
Identifier for the text detection job. Use JobId to identify the job in a subsequent call to
GetTextDetection.
String projectVersionArn
The Amazon Resource Name (ARN) of the model version that you want to delete.
This operation requires permissions to perform the rekognition:StopProjectVersion action.
String status
The current status of the stop operation.
String name
The name of a stream processor created by CreateStreamProcessor.
KinesisVideoStream kinesisVideoStream
The Kinesis video stream input stream for the source streaming video.
KinesisDataStream kinesisDataStream
The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.
FaceSearchSettings faceSearch
Face search settings to use on a streaming video.
S3Object s3Object
TestingData input
The testing dataset that was supplied for training.
TestingData output
The subset of the dataset that was actually tested. Some images (assets) might not be tested due to file formatting and other issues.
ValidationData validation
The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.
String detectedText
The word or line of text recognized by Amazon Rekognition.
String type
The type of text that was detected.
Integer id
The identifier for the detected text. The identifier is only unique for a single call to DetectText.
Integer parentId
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.
Float confidence
The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.
Geometry geometry
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.
Long timestamp
The time, in milliseconds from the start of the video, that the text was detected.
TextDetection textDetection
Details about text detected in a video.
TrainingData input
The training assets that you supplied for training.
TrainingData output
The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
ValidationData validation
The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.
List<E> reasons
An array of reasons that specify why a face wasn't indexed.
EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.
EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the
MaxFaces input parameter for IndexFaces.
LOW_BRIGHTNESS - The image is too dark.
LOW_SHARPNESS - The image is too blurry.
LOW_CONFIDENCE - The face was detected with a low confidence.
SMALL_BOUNDING_BOX - The bounding box around the face is too small.
FaceDetail faceDetail
The structure that contains attributes of a face that IndexFacesdetected, but didn't index.
S3Object s3Object
The Amazon S3 bucket name and file name for the video.
String codec
Type of compression used in the analyzed video.
Long durationMillis
Length of the video in milliseconds.
String format
Format of the analyzed video. Possible values are MP4, MOV and AVI.
Float frameRate
Number of frames per second in the video.
Long frameHeight
Vertical pixel dimension of the video.
Long frameWidth
Horizontal pixel dimension of the video.
Copyright © 2021. All rights reserved.