GetTextDetection
Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.
Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
calling StartTextDetection which returns a job identifier (JobId)
When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
topic registered in the initial call to StartTextDetection. To get the results
of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED.
if so, call GetTextDetection and pass the job identifier (JobId) from the initial call
of StartLabelDetection.
GetTextDetection returns an array of detected text (TextDetections) sorted by
the time the text was detected, up to 100 words per frame of video.
Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.
Use MaxResults parameter to limit the number of text detections returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains
a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection
and populate the NextToken request parameter with the token value returned from the previous
call to GetTextDetection.
Request Syntax
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$Required: Yes
- MaxResults
-
Maximum number of results to return per paginated call. The largest value you can specify is 1000.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No
Response Syntax
{
"JobId": "string",
"JobStatus": "string",
"JobTag": "string",
"NextToken": "string",
"StatusMessage": "string",
"TextDetections": [
{
"TextDetection": {
"Confidence": number,
"DetectedText": "string",
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": number,
"ParentId": number,
"Type": "string"
},
"Timestamp": number
}
],
"TextModelVersion": "string",
"Video": {
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
},
"VideoMetadata": {
"Codec": "string",
"ColorRange": "string",
"DurationMillis": number,
"Format": "string",
"FrameHeight": number,
"FrameRate": number,
"FrameWidth": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- JobId
-
Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$ - JobStatus
-
Current status of the text detection job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED - JobTag
-
A job identifier specified in the call to StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9_.\-:+=\/]+ - 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.
Type: String
Length Constraints: Maximum length of 255.
- StatusMessage
-
If the job fails,
StatusMessageprovides a descriptive error message.Type: String
- 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.
Type: Array of TextDetectionResult objects
- TextModelVersion
-
Version number of the text detection model that was used to detect text.
Type: String
- Video
-
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use
Videoto specify a video for analysis. The supported file formats are .mp4, .mov and .avi.Type: Video object
- VideoMetadata
-
Information about a video that Amazon Rekognition analyzed.
Videometadatais returned in every page of paginated responses from a Amazon Rekognition video operation.Type: VideoMetadata object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidPaginationTokenException
-
Pagination token in the request is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
