Network.AWS.Rekognition.GetFaceDetection

Gets face detection results for a Rekognition Video analysis started by .

Face detection with Rekognition Video is an asynchronous operation. You start face detection by calling which returns a job identifier (JobId ). When the face detection operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection . To get the results of the face detection operation, 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 StartFaceDetection .

GetFaceDetection returns an array of detected faces (Faces ) sorted by the time the faces were detected.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults , the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection .

Creating a Request

getFaceDetection

Arguments

:: Text

gfdJobId

-> GetFaceDetection

Creates a value of GetFaceDetection with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gfdNextToken - If the previous response was incomplete (because there are more faces to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
• gfdMaxResults - Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
• gfdJobId - Unique identifier for the face detection job. The JobId is returned from StartFaceDetection .

data GetFaceDetection

See: getFaceDetection smart constructor.

Instances

Eq GetFaceDetection

Methods

(==) :: GetFaceDetection -> GetFaceDetection -> Bool

(/=) :: GetFaceDetection -> GetFaceDetection -> Bool

Data GetFaceDetection

Methods

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

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

toConstr :: GetFaceDetection -> Constr

dataTypeOf :: GetFaceDetection -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetFaceDetection -> GetFaceDetection

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

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

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

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

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

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

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

Read GetFaceDetection

Methods

readsPrec :: Int -> ReadS GetFaceDetection

readList :: ReadS [GetFaceDetection]

readPrec :: ReadPrec GetFaceDetection

readListPrec :: ReadPrec [GetFaceDetection]

Show GetFaceDetection

Methods

showsPrec :: Int -> GetFaceDetection -> ShowS

show :: GetFaceDetection -> String

showList :: [GetFaceDetection] -> ShowS

Generic GetFaceDetection

Associated Types

type Rep GetFaceDetection :: * -> *

Methods

from :: GetFaceDetection -> Rep GetFaceDetection x

to :: Rep GetFaceDetection x -> GetFaceDetection

Hashable GetFaceDetection

Methods

hashWithSalt :: Int -> GetFaceDetection -> Int

hash :: GetFaceDetection -> Int

ToJSON GetFaceDetection

Methods

toJSON :: GetFaceDetection -> Value

toEncoding :: GetFaceDetection -> Encoding

toJSONList :: [GetFaceDetection] -> Value

toEncodingList :: [GetFaceDetection] -> Encoding

NFData GetFaceDetection

Methods

rnf :: GetFaceDetection -> ()

AWSRequest GetFaceDetection

Associated Types

type Rs GetFaceDetection :: *

Methods

request :: GetFaceDetection -> Request GetFaceDetection

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetFaceDetection -> ClientResponse -> m (Response GetFaceDetection)

ToHeaders GetFaceDetection

Methods

toHeaders :: GetFaceDetection -> [Header]

ToPath GetFaceDetection

Methods

toPath :: GetFaceDetection -> ByteString

ToQuery GetFaceDetection

Methods

toQuery :: GetFaceDetection -> QueryString

type Rep GetFaceDetection

type Rep GetFaceDetection = D1 * (MetaData "GetFaceDetection" "Network.AWS.Rekognition.GetFaceDetection" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetFaceDetection'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_gfdJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs GetFaceDetection

type Rs GetFaceDetection = GetFaceDetectionResponse

Request Lenses

gfdNextToken :: Lens' GetFaceDetection (Maybe Text)

If the previous response was incomplete (because there are more faces to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

gfdMaxResults :: Lens' GetFaceDetection (Maybe Natural)

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

gfdJobId :: Lens' GetFaceDetection Text

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection .

Destructuring the Response

getFaceDetectionResponse

Arguments

:: Int

gfdrsResponseStatus

-> GetFaceDetectionResponse

Creates a value of GetFaceDetectionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gfdrsNextToken - If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
• gfdrsVideoMetadata - Information about a video that Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.
• gfdrsStatusMessage - If the job fails, StatusMessage provides a descriptive error message.
• gfdrsFaces - An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
• gfdrsJobStatus - The current status of the face detection job.
• gfdrsResponseStatus - -- | The response status code.

data GetFaceDetectionResponse

See: getFaceDetectionResponse smart constructor.

Instances

Eq GetFaceDetectionResponse

Methods

(==) :: GetFaceDetectionResponse -> GetFaceDetectionResponse -> Bool

(/=) :: GetFaceDetectionResponse -> GetFaceDetectionResponse -> Bool

Data GetFaceDetectionResponse

Methods

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

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

toConstr :: GetFaceDetectionResponse -> Constr

dataTypeOf :: GetFaceDetectionResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetFaceDetectionResponse -> GetFaceDetectionResponse

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

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

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

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

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

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

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

Read GetFaceDetectionResponse

Methods

readsPrec :: Int -> ReadS GetFaceDetectionResponse

readList :: ReadS [GetFaceDetectionResponse]

readPrec :: ReadPrec GetFaceDetectionResponse

readListPrec :: ReadPrec [GetFaceDetectionResponse]

Show GetFaceDetectionResponse

Methods

showsPrec :: Int -> GetFaceDetectionResponse -> ShowS

show :: GetFaceDetectionResponse -> String

showList :: [GetFaceDetectionResponse] -> ShowS

Generic GetFaceDetectionResponse

Associated Types

type Rep GetFaceDetectionResponse :: * -> *

Methods

from :: GetFaceDetectionResponse -> Rep GetFaceDetectionResponse x

to :: Rep GetFaceDetectionResponse x -> GetFaceDetectionResponse

NFData GetFaceDetectionResponse

Methods

rnf :: GetFaceDetectionResponse -> ()

type Rep GetFaceDetectionResponse

type Rep GetFaceDetectionResponse = D1 * (MetaData "GetFaceDetectionResponse" "Network.AWS.Rekognition.GetFaceDetection" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetFaceDetectionResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdrsVideoMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoMetadata))) (S1 * (MetaSel (Just Symbol "_gfdrsStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdrsFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [FaceDetection]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gfdrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoJobStatus))) (S1 * (MetaSel (Just Symbol "_gfdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

gfdrsNextToken :: Lens' GetFaceDetectionResponse (Maybe Text)

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

gfdrsVideoMetadata :: Lens' GetFaceDetectionResponse (Maybe VideoMetadata)

Information about a video that Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

gfdrsStatusMessage :: Lens' GetFaceDetectionResponse (Maybe Text)

If the job fails, StatusMessage provides a descriptive error message.

gfdrsFaces :: Lens' GetFaceDetectionResponse [FaceDetection]

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

gfdrsJobStatus :: Lens' GetFaceDetectionResponse (Maybe VideoJobStatus)

The current status of the face detection job.

gfdrsResponseStatus :: Lens' GetFaceDetectionResponse Int

• - | The response status code.