Network.AWS.Rekognition.GetPersonTracking

Gets the person tracking results of a Rekognition Video analysis started by .

The person detection operation is started by a call to StartPersonTracking which returns a job identifier (JobId ). When the person detection operation finishes, Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking .

To get the results of the person tracking 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 StartPersonTracking .

GetPersonTracking returns an array, Persons , of tracked persons and the time(s) they were tracked in the video.

By default, the array is sorted by the time(s) a person is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

Use the MaxResults parameter to limit the number of items 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 GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking .

Creating a Request

getPersonTracking

Arguments

:: Text

gptJobId

-> GetPersonTracking

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

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

• gptNextToken - If the previous response was incomplete (because there are more persons to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.
• gptMaxResults - 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.
• gptSortBy - Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX , the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP .
• gptJobId - The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking .

data GetPersonTracking

See: getPersonTracking smart constructor.

Instances

Eq GetPersonTracking

Methods

(==) :: GetPersonTracking -> GetPersonTracking -> Bool

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

Data GetPersonTracking

Methods

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

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

toConstr :: GetPersonTracking -> Constr

dataTypeOf :: GetPersonTracking -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetPersonTracking

Methods

readsPrec :: Int -> ReadS GetPersonTracking

readList :: ReadS [GetPersonTracking]

readPrec :: ReadPrec GetPersonTracking

readListPrec :: ReadPrec [GetPersonTracking]

Show GetPersonTracking

Methods

showsPrec :: Int -> GetPersonTracking -> ShowS

show :: GetPersonTracking -> String

showList :: [GetPersonTracking] -> ShowS

Generic GetPersonTracking

Associated Types

type Rep GetPersonTracking :: * -> *

Methods

from :: GetPersonTracking -> Rep GetPersonTracking x

to :: Rep GetPersonTracking x -> GetPersonTracking

Hashable GetPersonTracking

Methods

hashWithSalt :: Int -> GetPersonTracking -> Int

hash :: GetPersonTracking -> Int

ToJSON GetPersonTracking

Methods

toJSON :: GetPersonTracking -> Value

toEncoding :: GetPersonTracking -> Encoding

toJSONList :: [GetPersonTracking] -> Value

toEncodingList :: [GetPersonTracking] -> Encoding

NFData GetPersonTracking

Methods

rnf :: GetPersonTracking -> ()

AWSRequest GetPersonTracking

Associated Types

type Rs GetPersonTracking :: *

Methods

request :: GetPersonTracking -> Request GetPersonTracking

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

ToHeaders GetPersonTracking

Methods

toHeaders :: GetPersonTracking -> [Header]

ToPath GetPersonTracking

Methods

toPath :: GetPersonTracking -> ByteString

ToQuery GetPersonTracking

Methods

toQuery :: GetPersonTracking -> QueryString

type Rep GetPersonTracking

type Rep GetPersonTracking = D1 * (MetaData "GetPersonTracking" "Network.AWS.Rekognition.GetPersonTracking" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetPersonTracking'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gptNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gptMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gptSortBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe PersonTrackingSortBy))) (S1 * (MetaSel (Just Symbol "_gptJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs GetPersonTracking

type Rs GetPersonTracking = GetPersonTrackingResponse

Request Lenses

gptNextToken :: Lens' GetPersonTracking (Maybe Text)

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

gptMaxResults :: Lens' GetPersonTracking (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.

gptSortBy :: Lens' GetPersonTracking (Maybe PersonTrackingSortBy)

Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX , the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP .

gptJobId :: Lens' GetPersonTracking Text

The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking .

Destructuring the Response

getPersonTrackingResponse

Arguments

:: Int

gptrsResponseStatus

-> GetPersonTrackingResponse

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

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

• gptrsNextToken - If the response is truncated, Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.
• gptrsVideoMetadata - Information about a video that Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Rekognition Video operation.
• gptrsStatusMessage - If the job fails, StatusMessage provides a descriptive error message.
• gptrsJobStatus - The current status of the person tracking job.
• gptrsPersons - An array of the persons detected in the video and the times they are tracked throughout the video. An array element will exist for each time the person is tracked.
• gptrsResponseStatus - -- | The response status code.

data GetPersonTrackingResponse

See: getPersonTrackingResponse smart constructor.

Instances

Eq GetPersonTrackingResponse

Methods

(==) :: GetPersonTrackingResponse -> GetPersonTrackingResponse -> Bool

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

Data GetPersonTrackingResponse

Methods

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

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

toConstr :: GetPersonTrackingResponse -> Constr

dataTypeOf :: GetPersonTrackingResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetPersonTrackingResponse

Methods

readsPrec :: Int -> ReadS GetPersonTrackingResponse

readList :: ReadS [GetPersonTrackingResponse]

readPrec :: ReadPrec GetPersonTrackingResponse

readListPrec :: ReadPrec [GetPersonTrackingResponse]

Show GetPersonTrackingResponse

Methods

showsPrec :: Int -> GetPersonTrackingResponse -> ShowS

show :: GetPersonTrackingResponse -> String

showList :: [GetPersonTrackingResponse] -> ShowS

Generic GetPersonTrackingResponse

Associated Types

type Rep GetPersonTrackingResponse :: * -> *

Methods

from :: GetPersonTrackingResponse -> Rep GetPersonTrackingResponse x

to :: Rep GetPersonTrackingResponse x -> GetPersonTrackingResponse

NFData GetPersonTrackingResponse

Methods

rnf :: GetPersonTrackingResponse -> ()

type Rep GetPersonTrackingResponse

type Rep GetPersonTrackingResponse = D1 * (MetaData "GetPersonTrackingResponse" "Network.AWS.Rekognition.GetPersonTracking" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "GetPersonTrackingResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gptrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gptrsVideoMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoMetadata))) (S1 * (MetaSel (Just Symbol "_gptrsStatusMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gptrsJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VideoJobStatus))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gptrsPersons") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PersonDetection]))) (S1 * (MetaSel (Just Symbol "_gptrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

gptrsNextToken :: Lens' GetPersonTrackingResponse (Maybe Text)

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

gptrsVideoMetadata :: Lens' GetPersonTrackingResponse (Maybe VideoMetadata)

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

gptrsStatusMessage :: Lens' GetPersonTrackingResponse (Maybe Text)

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

gptrsJobStatus :: Lens' GetPersonTrackingResponse (Maybe VideoJobStatus)

The current status of the person tracking job.

gptrsPersons :: Lens' GetPersonTrackingResponse [PersonDetection]

An array of the persons detected in the video and the times they are tracked throughout the video. An array element will exist for each time the person is tracked.

gptrsResponseStatus :: Lens' GetPersonTrackingResponse Int

• - | The response status code.