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 the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.
The video must be stored in an Amazon S3 bucket. Use Video
to specify the bucket name and the filename of the video. StartFaceSearch
returns a job identifier (JobId
) which you use to get the search results once the search has completed. When searching is finished, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel
. To get the search results, 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 StartFaceSearch
. For more information, see 'collections-search-person' .
- startFaceSearch :: Video -> Text -> StartFaceSearch
- data StartFaceSearch
- sfsFaceMatchThreshold :: Lens' StartFaceSearch (Maybe Double)
- sfsJobTag :: Lens' StartFaceSearch (Maybe Text)
- sfsNotificationChannel :: Lens' StartFaceSearch (Maybe NotificationChannel)
- sfsClientRequestToken :: Lens' StartFaceSearch (Maybe Text)
- sfsVideo :: Lens' StartFaceSearch Video
- sfsCollectionId :: Lens' StartFaceSearch Text
- startFaceSearchResponse :: Int -> StartFaceSearchResponse
- data StartFaceSearchResponse
- sfsrsJobId :: Lens' StartFaceSearchResponse (Maybe Text)
- sfsrsResponseStatus :: Lens' StartFaceSearchResponse Int
Creating a Request
Creates a value of StartFaceSearch
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfsFaceMatchThreshold
- The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.sfsJobTag
- Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.sfsNotificationChannel
- The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the search.sfsClientRequestToken
- Idempotent token used to identify the start request. If you use the same token with multipleStartFaceSearch
requests, the sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.sfsVideo
- The video you want to search. The video must be stored in an Amazon S3 bucket.sfsCollectionId
- ID of the collection that contains the faces you want to search for.
data StartFaceSearch Source #
See: startFaceSearch
smart constructor.
Request Lenses
sfsFaceMatchThreshold :: Lens' StartFaceSearch (Maybe Double) Source #
The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.
sfsJobTag :: Lens' StartFaceSearch (Maybe Text) Source #
Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
sfsNotificationChannel :: Lens' StartFaceSearch (Maybe NotificationChannel) Source #
The ARN of the Amazon SNS topic to which you want Rekognition Video to publish the completion status of the search.
sfsClientRequestToken :: Lens' StartFaceSearch (Maybe Text) Source #
Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidently started more than once.
sfsVideo :: Lens' StartFaceSearch Video Source #
The video you want to search. The video must be stored in an Amazon S3 bucket.
sfsCollectionId :: Lens' StartFaceSearch Text Source #
ID of the collection that contains the faces you want to search for.
Destructuring the Response
startFaceSearchResponse Source #
Creates a value of StartFaceSearchResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfsrsJobId
- The identifier for the search job. UseJobId
to identify the job in a subsequent call toGetFaceSearch
.sfsrsResponseStatus
- -- | The response status code.
data StartFaceSearchResponse Source #
See: startFaceSearchResponse
smart constructor.
Response Lenses
sfsrsJobId :: Lens' StartFaceSearchResponse (Maybe Text) Source #
The identifier for the search job. Use JobId
to identify the job in a subsequent call to GetFaceSearch
.
sfsrsResponseStatus :: Lens' StartFaceSearchResponse Int Source #
- - | The response status code.