New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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 50 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.
Example
Use a bare-bones client and the command you need to make an API call.
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 toStartTextDetection
. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic isSUCCEEDED
. if so, callGetTextDetection
and pass the job identifier (JobId
) from the initial call ofStartLabelDetection
.GetTextDetection
returns an array of detected text (TextDetections
) sorted by the time the text was detected, up to 50 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 ofNextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, callGetTextDetection
and populate theNextToken
request parameter with the token value returned from the previous call toGetTextDetection
.Example
Use a bare-bones client and the command you need to make an API call.
Param
GetTextDetectionCommandInput
Returns
GetTextDetectionCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You are not authorized to perform the action.
Throws
InternalServerError (server fault)
Amazon Rekognition experienced a service issue. Try your call again.
Throws
InvalidPaginationTokenException (client fault)
Pagination token in the request is not valid.
Throws
InvalidParameterException (client fault)
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
Throws
ProvisionedThroughputExceededException (client fault)
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
Throws
ResourceNotFoundException (client fault)
The resource specified in the request cannot be found.
Throws
ThrottlingException (server fault)
Amazon Rekognition is temporarily unable to process the request. Try your call again.
Throws
RekognitionServiceException
Base exception class for all service exceptions from Rekognition service.