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

Network.AWS.Rekognition.StartCelebrityRecognition

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 .

Creating a Request

startCelebrityRecognition #

Arguments

:: Video	`scrVideo`
-> StartCelebrityRecognition

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

See: startCelebrityRecognition smart constructor.

Instances

Eq StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods (==) :: StartCelebrityRecognition -> StartCelebrityRecognition -> Bool # (/=) :: StartCelebrityRecognition -> StartCelebrityRecognition -> Bool #
Data StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartCelebrityRecognition -> c StartCelebrityRecognition # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartCelebrityRecognition # toConstr :: StartCelebrityRecognition -> Constr # dataTypeOf :: StartCelebrityRecognition -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartCelebrityRecognition) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartCelebrityRecognition) # gmapT :: (forall b. Data b => b -> b) -> StartCelebrityRecognition -> StartCelebrityRecognition # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartCelebrityRecognition -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartCelebrityRecognition -> r # gmapQ :: (forall d. Data d => d -> u) -> StartCelebrityRecognition -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartCelebrityRecognition -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartCelebrityRecognition -> m StartCelebrityRecognition # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartCelebrityRecognition -> m StartCelebrityRecognition # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartCelebrityRecognition -> m StartCelebrityRecognition #
Read StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods readsPrec :: Int -> ReadS StartCelebrityRecognition # readList :: ReadS [StartCelebrityRecognition] # readPrec :: ReadPrec StartCelebrityRecognition # readListPrec :: ReadPrec [StartCelebrityRecognition] #
Show StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods showsPrec :: Int -> StartCelebrityRecognition -> ShowS # show :: StartCelebrityRecognition -> String # showList :: [StartCelebrityRecognition] -> ShowS #
Generic StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Associated Types type Rep StartCelebrityRecognition :: Type -> Type # Methods from :: StartCelebrityRecognition -> Rep StartCelebrityRecognition x # to :: Rep StartCelebrityRecognition x -> StartCelebrityRecognition #
Hashable StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods hashWithSalt :: Int -> StartCelebrityRecognition -> Int # hash :: StartCelebrityRecognition -> Int #
ToJSON StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods toJSON :: StartCelebrityRecognition -> Value # toEncoding :: StartCelebrityRecognition -> Encoding # toJSONList :: [StartCelebrityRecognition] -> Value # toEncodingList :: [StartCelebrityRecognition] -> Encoding #
AWSRequest StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Associated Types type Rs StartCelebrityRecognition :: Type # Methods request :: StartCelebrityRecognition -> Request StartCelebrityRecognition # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StartCelebrityRecognition -> ClientResponse -> m (Response StartCelebrityRecognition) #
ToHeaders StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods toHeaders :: StartCelebrityRecognition -> [Header] #
ToPath StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods toPath :: StartCelebrityRecognition -> ByteString #
ToQuery StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods toQuery :: StartCelebrityRecognition -> QueryString #
NFData StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods rnf :: StartCelebrityRecognition -> () #
type Rep StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition type Rep StartCelebrityRecognition = D1 (MetaData "StartCelebrityRecognition" "Network.AWS.Rekognition.StartCelebrityRecognition" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" False) (C1 (MetaCons "StartCelebrityRecognition'" PrefixI True) ((S1 (MetaSel (Just "_scrJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_scrNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NotificationChannel))) :: (S1 (MetaSel (Just "_scrClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_scrVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Video))))
type Rs StartCelebrityRecognition #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition type Rs StartCelebrityRecognition = StartCelebrityRecognitionResponse

Request Lenses

scrJobTag :: Lens' StartCelebrityRecognition (Maybe Text) #

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

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

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 #

The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

Destructuring the Response

startCelebrityRecognitionResponse #

Arguments

:: Int	`scrrsResponseStatus`
-> StartCelebrityRecognitionResponse

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

data StartCelebrityRecognitionResponse #

See: startCelebrityRecognitionResponse smart constructor.

Instances

Eq StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods (==) :: StartCelebrityRecognitionResponse -> StartCelebrityRecognitionResponse -> Bool # (/=) :: StartCelebrityRecognitionResponse -> StartCelebrityRecognitionResponse -> Bool #
Data StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartCelebrityRecognitionResponse -> c StartCelebrityRecognitionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartCelebrityRecognitionResponse # toConstr :: StartCelebrityRecognitionResponse -> Constr # dataTypeOf :: StartCelebrityRecognitionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StartCelebrityRecognitionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartCelebrityRecognitionResponse) # gmapT :: (forall b. Data b => b -> b) -> StartCelebrityRecognitionResponse -> StartCelebrityRecognitionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartCelebrityRecognitionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartCelebrityRecognitionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StartCelebrityRecognitionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StartCelebrityRecognitionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartCelebrityRecognitionResponse -> m StartCelebrityRecognitionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartCelebrityRecognitionResponse -> m StartCelebrityRecognitionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartCelebrityRecognitionResponse -> m StartCelebrityRecognitionResponse #
Read StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods readsPrec :: Int -> ReadS StartCelebrityRecognitionResponse # readList :: ReadS [StartCelebrityRecognitionResponse] # readPrec :: ReadPrec StartCelebrityRecognitionResponse # readListPrec :: ReadPrec [StartCelebrityRecognitionResponse] #
Show StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods showsPrec :: Int -> StartCelebrityRecognitionResponse -> ShowS # show :: StartCelebrityRecognitionResponse -> String # showList :: [StartCelebrityRecognitionResponse] -> ShowS #
Generic StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Associated Types type Rep StartCelebrityRecognitionResponse :: Type -> Type # Methods from :: StartCelebrityRecognitionResponse -> Rep StartCelebrityRecognitionResponse x # to :: Rep StartCelebrityRecognitionResponse x -> StartCelebrityRecognitionResponse #
NFData StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition Methods rnf :: StartCelebrityRecognitionResponse -> () #
type Rep StartCelebrityRecognitionResponse #
Instance details Defined in Network.AWS.Rekognition.StartCelebrityRecognition type Rep StartCelebrityRecognitionResponse = D1 (MetaData "StartCelebrityRecognitionResponse" "Network.AWS.Rekognition.StartCelebrityRecognition" "amazonka-rekognition-1.6.1-LJYoSuoGbtd78kiYOWkJFK" False) (C1 (MetaCons "StartCelebrityRecognitionResponse'" PrefixI True) (S1 (MetaSel (Just "_scrrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_scrrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

scrrsJobId :: Lens' StartCelebrityRecognitionResponse (Maybe Text) #

The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition .

scrrsResponseStatus :: Lens' StartCelebrityRecognitionResponse Int #

- | The response status code.