| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.StartTextDetection
Description
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.
Synopsis
- data StartTextDetection = StartTextDetection' {}
- newStartTextDetection :: Video -> StartTextDetection
- startTextDetection_jobTag :: Lens' StartTextDetection (Maybe Text)
- startTextDetection_filters :: Lens' StartTextDetection (Maybe StartTextDetectionFilters)
- startTextDetection_notificationChannel :: Lens' StartTextDetection (Maybe NotificationChannel)
- startTextDetection_clientRequestToken :: Lens' StartTextDetection (Maybe Text)
- startTextDetection_video :: Lens' StartTextDetection Video
- data StartTextDetectionResponse = StartTextDetectionResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newStartTextDetectionResponse :: Int -> StartTextDetectionResponse
- startTextDetectionResponse_jobId :: Lens' StartTextDetectionResponse (Maybe Text)
- startTextDetectionResponse_httpStatus :: Lens' StartTextDetectionResponse Int
Creating a Request
data StartTextDetection Source #
See: newStartTextDetection smart constructor.
Constructors
| StartTextDetection' | |
Fields
| |
Instances
newStartTextDetection Source #
Arguments
| :: Video | |
| -> StartTextDetection |
Create a value of StartTextDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobTag:StartTextDetection', startTextDetection_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.
$sel:filters:StartTextDetection', startTextDetection_filters - Optional parameters that let you set criteria the text must meet to be
included in your response.
$sel:notificationChannel:StartTextDetection', startTextDetection_notificationChannel - Undocumented member.
$sel:clientRequestToken:StartTextDetection', startTextDetection_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.
$sel:video:StartTextDetection', startTextDetection_video - Undocumented member.
Request Lenses
startTextDetection_jobTag :: Lens' StartTextDetection (Maybe Text) Source #
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.
startTextDetection_filters :: Lens' StartTextDetection (Maybe StartTextDetectionFilters) Source #
Optional parameters that let you set criteria the text must meet to be included in your response.
startTextDetection_notificationChannel :: Lens' StartTextDetection (Maybe NotificationChannel) Source #
Undocumented member.
startTextDetection_clientRequestToken :: Lens' StartTextDetection (Maybe Text) Source #
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.
startTextDetection_video :: Lens' StartTextDetection Video Source #
Undocumented member.
Destructuring the Response
data StartTextDetectionResponse Source #
See: newStartTextDetectionResponse smart constructor.
Constructors
| StartTextDetectionResponse' | |
Fields
| |
Instances
newStartTextDetectionResponse Source #
Create a value of StartTextDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobId:StartTextDetectionResponse', startTextDetectionResponse_jobId - Identifier for the text detection job. Use JobId to identify the job
in a subsequent call to GetTextDetection.
$sel:httpStatus:StartTextDetectionResponse', startTextDetectionResponse_httpStatus - The response's http status code.
Response Lenses
startTextDetectionResponse_jobId :: Lens' StartTextDetectionResponse (Maybe Text) Source #
Identifier for the text detection job. Use JobId to identify the job
in a subsequent call to GetTextDetection.
startTextDetectionResponse_httpStatus :: Lens' StartTextDetectionResponse Int Source #
The response's http status code.