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.StartFaceSearch

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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, Amazon 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 GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

Synopsis

data StartFaceSearch = StartFaceSearch' {
- faceMatchThreshold :: Maybe Double
- jobTag :: Maybe Text
- notificationChannel :: Maybe NotificationChannel
- clientRequestToken :: Maybe Text
- video :: Video
- collectionId :: Text
}
newStartFaceSearch :: Video -> Text -> StartFaceSearch
startFaceSearch_faceMatchThreshold :: Lens' StartFaceSearch (Maybe Double)
startFaceSearch_jobTag :: Lens' StartFaceSearch (Maybe Text)
startFaceSearch_notificationChannel :: Lens' StartFaceSearch (Maybe NotificationChannel)
startFaceSearch_clientRequestToken :: Lens' StartFaceSearch (Maybe Text)
startFaceSearch_video :: Lens' StartFaceSearch Video
startFaceSearch_collectionId :: Lens' StartFaceSearch Text
data StartFaceSearchResponse = StartFaceSearchResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
}
newStartFaceSearchResponse :: Int -> StartFaceSearchResponse
startFaceSearchResponse_jobId :: Lens' StartFaceSearchResponse (Maybe Text)
startFaceSearchResponse_httpStatus :: Lens' StartFaceSearchResponse Int

Creating a Request

data StartFaceSearch Source #

See: newStartFaceSearch smart constructor.

Constructors

StartFaceSearch'

Fields

faceMatchThreshold :: Maybe Double
The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.
jobTag :: Maybe Text
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
notificationChannel :: Maybe NotificationChannel
The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. 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.
clientRequestToken :: Maybe Text
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.
video :: Video
The video you want to search. The video must be stored in an Amazon S3 bucket.
collectionId :: Text
ID of the collection that contains the faces you want to search for.

Instances

Instances details

Eq StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods (==) :: StartFaceSearch -> StartFaceSearch -> Bool # (/=) :: StartFaceSearch -> StartFaceSearch -> Bool #
Read StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods readsPrec :: Int -> ReadS StartFaceSearch # readList :: ReadS [StartFaceSearch] # readPrec :: ReadPrec StartFaceSearch # readListPrec :: ReadPrec [StartFaceSearch] #
Show StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods showsPrec :: Int -> StartFaceSearch -> ShowS # show :: StartFaceSearch -> String # showList :: [StartFaceSearch] -> ShowS #
Generic StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Associated Types type Rep StartFaceSearch :: Type -> Type # Methods from :: StartFaceSearch -> Rep StartFaceSearch x # to :: Rep StartFaceSearch x -> StartFaceSearch #
NFData StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods rnf :: StartFaceSearch -> () #
Hashable StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods hashWithSalt :: Int -> StartFaceSearch -> Int # hash :: StartFaceSearch -> Int #
ToJSON StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods toJSON :: StartFaceSearch -> Value # toEncoding :: StartFaceSearch -> Encoding # toJSONList :: [StartFaceSearch] -> Value # toEncodingList :: [StartFaceSearch] -> Encoding #
AWSRequest StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Associated Types type AWSResponse StartFaceSearch # Methods request :: StartFaceSearch -> Request StartFaceSearch # response :: MonadResource m => Logger -> Service -> Proxy StartFaceSearch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartFaceSearch))) #
ToHeaders StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods toHeaders :: StartFaceSearch -> [Header] #
ToPath StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods toPath :: StartFaceSearch -> ByteString #
ToQuery StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods toQuery :: StartFaceSearch -> QueryString #
type Rep StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch type Rep StartFaceSearch = D1 ('MetaData "StartFaceSearch" "Amazonka.Rekognition.StartFaceSearch" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartFaceSearch'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faceMatchThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)))) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video) :*: S1 ('MetaSel ('Just "collectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartFaceSearch Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch type AWSResponse StartFaceSearch = StartFaceSearchResponse

newStartFaceSearch Source #

Arguments

:: Video	`$sel:video:StartFaceSearch'`
-> Text	`$sel:collectionId:StartFaceSearch'`
-> StartFaceSearch

Create a value of StartFaceSearch 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:faceMatchThreshold:StartFaceSearch', startFaceSearch_faceMatchThreshold - The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

$sel:jobTag:StartFaceSearch', startFaceSearch_jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

$sel:notificationChannel:StartFaceSearch', startFaceSearch_notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. 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.

$sel:clientRequestToken:StartFaceSearch', startFaceSearch_clientRequestToken - 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.

$sel:video:StartFaceSearch', startFaceSearch_video - The video you want to search. The video must be stored in an Amazon S3 bucket.

$sel:collectionId:StartFaceSearch', startFaceSearch_collectionId - ID of the collection that contains the faces you want to search for.

Request Lenses

startFaceSearch_faceMatchThreshold :: 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%. The default value is 80%.

startFaceSearch_jobTag :: Lens' StartFaceSearch (Maybe Text) Source #

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

startFaceSearch_notificationChannel :: Lens' StartFaceSearch (Maybe NotificationChannel) Source #

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. 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.

startFaceSearch_clientRequestToken :: 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.

startFaceSearch_video :: Lens' StartFaceSearch Video Source #

The video you want to search. The video must be stored in an Amazon S3 bucket.

startFaceSearch_collectionId :: Lens' StartFaceSearch Text Source #

ID of the collection that contains the faces you want to search for.

Destructuring the Response

data StartFaceSearchResponse Source #

See: newStartFaceSearchResponse smart constructor.

Constructors

StartFaceSearchResponse'
Fields jobId :: Maybe Text The identifier for the search job. Use `JobId` to identify the job in a subsequent call to `GetFaceSearch`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods (==) :: StartFaceSearchResponse -> StartFaceSearchResponse -> Bool # (/=) :: StartFaceSearchResponse -> StartFaceSearchResponse -> Bool #
Read StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods readsPrec :: Int -> ReadS StartFaceSearchResponse # readList :: ReadS [StartFaceSearchResponse] # readPrec :: ReadPrec StartFaceSearchResponse # readListPrec :: ReadPrec [StartFaceSearchResponse] #
Show StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods showsPrec :: Int -> StartFaceSearchResponse -> ShowS # show :: StartFaceSearchResponse -> String # showList :: [StartFaceSearchResponse] -> ShowS #
Generic StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Associated Types type Rep StartFaceSearchResponse :: Type -> Type # Methods from :: StartFaceSearchResponse -> Rep StartFaceSearchResponse x # to :: Rep StartFaceSearchResponse x -> StartFaceSearchResponse #
NFData StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch Methods rnf :: StartFaceSearchResponse -> () #
type Rep StartFaceSearchResponse Source #
Instance details Defined in Amazonka.Rekognition.StartFaceSearch type Rep StartFaceSearchResponse = D1 ('MetaData "StartFaceSearchResponse" "Amazonka.Rekognition.StartFaceSearch" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" 'False) (C1 ('MetaCons "StartFaceSearchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartFaceSearchResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartFaceSearchResponse'`
-> StartFaceSearchResponse

Create a value of StartFaceSearchResponse 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:StartFaceSearchResponse', startFaceSearchResponse_jobId - The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.

$sel:httpStatus:StartFaceSearchResponse', startFaceSearchResponse_httpStatus - The response's http status code.

Response Lenses

startFaceSearchResponse_jobId :: Lens' StartFaceSearchResponse (Maybe Text) Source #

The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.

startFaceSearchResponse_httpStatus :: Lens' StartFaceSearchResponse Int Source #

The response's http status code.