StartTextDetection
Starts asynchronous detection of text in a stored video.
Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and
the filename of the video. StartTextDetection
returns a job identifier (JobId
) which you use to get
the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
that you specify in NotificationChannel
.
To get the results of the text detection operation, first check that the status value published to the Amazon SNS
topic is SUCCEEDED
. if so, call GetTextDetection and pass the job identifier (JobId
)
from the initial call to StartTextDetection
.
Request Syntax
{
"ClientRequestToken": "string
",
"Filters": {
"RegionsOfInterest": [
{
"BoundingBox": {
"Height": number
,
"Left": number
,
"Top": number
,
"Width": number
},
"Polygon": [
{
"X": number
,
"Y": number
}
]
}
],
"WordFilter": {
"MinBoundingBoxHeight": number
,
"MinBoundingBoxWidth": number
,
"MinConfidence": number
}
},
"JobTag": "string
",
"NotificationChannel": {
"RoleArn": "string
",
"SNSTopicArn": "string
"
},
"Video": {
"S3Object": {
"Bucket": "string
",
"Name": "string
",
"Version": "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.
- ClientRequestToken
-
Idempotent token used to identify the start request. If you use the same token with multiple
StartTextDetection
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidentaly started more than once.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Required: No
- Filters
-
Optional parameters that let you set criteria the text must meet to be included in your response.
Type: StartTextDetectionFilters object
Required: No
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[a-zA-Z0-9_.\-:+=\/]+
Required: No
- NotificationChannel
-
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.
Type: NotificationChannel object
Required: No
- Video
-
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use
Video
to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.Type: Video object
Required: Yes
Response Syntax
{
"JobId": "string"
}
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
-
Identifier for the text detection job. Use
JobId
to identify the job in a subsequent call toGetTextDetection
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
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
- IdempotentParameterMismatchException
-
A
ClientRequestToken
input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- InvalidS3ObjectException
-
Amazon Rekognition is unable to access the S3 object specified in the request.
HTTP Status Code: 400
- LimitExceededException
-
An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex:
StartLabelDetection
) will raise aLimitExceededException
exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.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
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
- VideoTooLargeException
-
The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: