Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Starts asynchronous recognition of celebrities in a stored video.
Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video
to specify the bucket name and the filename of the video. StartCelebrityRecognition
returns a job identifier (JobId
) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call and pass the job identifier (JobId
) from the initial call to StartCelebrityRecognition
. For more information, see celebrities
.
- startCelebrityRecognition :: Video -> StartCelebrityRecognition
- data StartCelebrityRecognition
- scrJobTag :: Lens' StartCelebrityRecognition (Maybe Text)
- scrNotificationChannel :: Lens' StartCelebrityRecognition (Maybe NotificationChannel)
- scrClientRequestToken :: Lens' StartCelebrityRecognition (Maybe Text)
- scrVideo :: Lens' StartCelebrityRecognition Video
- startCelebrityRecognitionResponse :: Int -> StartCelebrityRecognitionResponse
- data StartCelebrityRecognitionResponse
- scrrsJobId :: Lens' StartCelebrityRecognitionResponse (Maybe Text)
- scrrsResponseStatus :: Lens' StartCelebrityRecognitionResponse Int
Creating a Request
startCelebrityRecognition Source #
Creates a value of StartCelebrityRecognition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scrJobTag
- Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.scrNotificationChannel
- The Amazon SNS topic ARN that you want Rekognition Video to publish the completion status of the celebrity recognition analysis to.scrClientRequestToken
- Idempotent token used to identify the start request. If you use the same token with multipleStartCelebrityRecognition
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.scrVideo
- The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
data StartCelebrityRecognition Source #
See: startCelebrityRecognition
smart constructor.
Request Lenses
scrJobTag :: Lens' StartCelebrityRecognition (Maybe Text) Source #
Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
scrNotificationChannel :: Lens' StartCelebrityRecognition (Maybe NotificationChannel) Source #
The Amazon SNS topic ARN that you want Rekognition Video to publish the completion status of the celebrity recognition analysis to.
scrClientRequestToken :: Lens' StartCelebrityRecognition (Maybe Text) Source #
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.
scrVideo :: Lens' StartCelebrityRecognition Video Source #
The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.
Destructuring the Response
startCelebrityRecognitionResponse Source #
Creates a value of StartCelebrityRecognitionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scrrsJobId
- The identifier for the celebrity recognition analysis job. UseJobId
to identify the job in a subsequent call toGetCelebrityRecognition
.scrrsResponseStatus
- -- | The response status code.
data StartCelebrityRecognitionResponse Source #
See: startCelebrityRecognitionResponse
smart constructor.
Response Lenses
scrrsJobId :: Lens' StartCelebrityRecognitionResponse (Maybe Text) Source #
The identifier for the celebrity recognition analysis job. Use JobId
to identify the job in a subsequent call to GetCelebrityRecognition
.
scrrsResponseStatus :: Lens' StartCelebrityRecognitionResponse Int Source #
- - | The response status code.