amazonka-rekognition-1.6.0: Amazon Rekognition SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Rekognition.StartFaceSearch

Contents

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, 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' .

Synopsis

Creating a Request

startFaceSearch #

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 multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken 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 #

See: startFaceSearch smart constructor.

Instances

Eq StartFaceSearch # 
Data StartFaceSearch # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartFaceSearch -> c StartFaceSearch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartFaceSearch #

toConstr :: StartFaceSearch -> Constr #

dataTypeOf :: StartFaceSearch -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartFaceSearch) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartFaceSearch) #

gmapT :: (forall b. Data b => b -> b) -> StartFaceSearch -> StartFaceSearch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartFaceSearch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartFaceSearch -> r #

gmapQ :: (forall d. Data d => d -> u) -> StartFaceSearch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartFaceSearch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartFaceSearch -> m StartFaceSearch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartFaceSearch -> m StartFaceSearch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartFaceSearch -> m StartFaceSearch #

Read StartFaceSearch # 
Show StartFaceSearch # 
Generic StartFaceSearch # 
Hashable StartFaceSearch # 
ToJSON StartFaceSearch # 
NFData StartFaceSearch # 

Methods

rnf :: StartFaceSearch -> () #

AWSRequest StartFaceSearch # 
ToHeaders StartFaceSearch # 
ToPath StartFaceSearch # 
ToQuery StartFaceSearch # 
type Rep StartFaceSearch # 
type Rep StartFaceSearch = D1 * (MetaData "StartFaceSearch" "Network.AWS.Rekognition.StartFaceSearch" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" False) (C1 * (MetaCons "StartFaceSearch'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sfsFaceMatchThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfsJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sfsNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NotificationChannel))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfsClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfsVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Video)) (S1 * (MetaSel (Just Symbol "_sfsCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs StartFaceSearch # 

Request Lenses

sfsFaceMatchThreshold :: Lens' StartFaceSearch (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%.

sfsJobTag :: Lens' StartFaceSearch (Maybe Text) #

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) #

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) #

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 #

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

sfsCollectionId :: Lens' StartFaceSearch Text #

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

Destructuring the Response

startFaceSearchResponse #

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. Use JobId to identify the job in a subsequent call to GetFaceSearch .
  • sfsrsResponseStatus - -- | The response status code.

data StartFaceSearchResponse #

See: startFaceSearchResponse smart constructor.

Instances

Eq StartFaceSearchResponse # 
Data StartFaceSearchResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartFaceSearchResponse -> c StartFaceSearchResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartFaceSearchResponse #

toConstr :: StartFaceSearchResponse -> Constr #

dataTypeOf :: StartFaceSearchResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartFaceSearchResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartFaceSearchResponse) #

gmapT :: (forall b. Data b => b -> b) -> StartFaceSearchResponse -> StartFaceSearchResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartFaceSearchResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartFaceSearchResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> StartFaceSearchResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartFaceSearchResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartFaceSearchResponse -> m StartFaceSearchResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartFaceSearchResponse -> m StartFaceSearchResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartFaceSearchResponse -> m StartFaceSearchResponse #

Read StartFaceSearchResponse # 
Show StartFaceSearchResponse # 
Generic StartFaceSearchResponse # 
NFData StartFaceSearchResponse # 

Methods

rnf :: StartFaceSearchResponse -> () #

type Rep StartFaceSearchResponse # 
type Rep StartFaceSearchResponse = D1 * (MetaData "StartFaceSearchResponse" "Network.AWS.Rekognition.StartFaceSearch" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" False) (C1 * (MetaCons "StartFaceSearchResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sfsrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sfsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sfsrsJobId :: Lens' StartFaceSearchResponse (Maybe Text) #

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

sfsrsResponseStatus :: Lens' StartFaceSearchResponse Int #

  • - | The response status code.