Network.AWS.Rekognition.StartPersonTracking

Starts the asynchronous tracking of persons in a stored video.

Rekognition Video can track persons in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId ) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel .

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

Creating a Request

startPersonTracking

Arguments

:: Video

sptVideo

-> StartPersonTracking

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

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

• sptJobTag - Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.
• sptNotificationChannel - The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the people detection operation to.
• sptClientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
• sptVideo - The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

data StartPersonTracking

See: startPersonTracking smart constructor.

Instances

Eq StartPersonTracking

Methods

(==) :: StartPersonTracking -> StartPersonTracking -> Bool

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

Data StartPersonTracking

Methods

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

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

toConstr :: StartPersonTracking -> Constr

dataTypeOf :: StartPersonTracking -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartPersonTracking

Methods

readsPrec :: Int -> ReadS StartPersonTracking

readList :: ReadS [StartPersonTracking]

readPrec :: ReadPrec StartPersonTracking

readListPrec :: ReadPrec [StartPersonTracking]

Show StartPersonTracking

Methods

showsPrec :: Int -> StartPersonTracking -> ShowS

show :: StartPersonTracking -> String

showList :: [StartPersonTracking] -> ShowS

Generic StartPersonTracking

Associated Types

type Rep StartPersonTracking :: * -> *

Methods

from :: StartPersonTracking -> Rep StartPersonTracking x

to :: Rep StartPersonTracking x -> StartPersonTracking

Hashable StartPersonTracking

Methods

hashWithSalt :: Int -> StartPersonTracking -> Int

hash :: StartPersonTracking -> Int

ToJSON StartPersonTracking

Methods

toJSON :: StartPersonTracking -> Value

toEncoding :: StartPersonTracking -> Encoding

toJSONList :: [StartPersonTracking] -> Value

toEncodingList :: [StartPersonTracking] -> Encoding

NFData StartPersonTracking

Methods

rnf :: StartPersonTracking -> ()

AWSRequest StartPersonTracking

Associated Types

type Rs StartPersonTracking :: *

Methods

request :: StartPersonTracking -> Request StartPersonTracking

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

ToHeaders StartPersonTracking

Methods

toHeaders :: StartPersonTracking -> [Header]

ToPath StartPersonTracking

Methods

toPath :: StartPersonTracking -> ByteString

ToQuery StartPersonTracking

Methods

toQuery :: StartPersonTracking -> QueryString

type Rep StartPersonTracking

type Rep StartPersonTracking = D1 * (MetaData "StartPersonTracking" "Network.AWS.Rekognition.StartPersonTracking" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "StartPersonTracking'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sptJobTag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sptNotificationChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe NotificationChannel)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sptClientRequestToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sptVideo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Video)))))

type Rs StartPersonTracking

type Rs StartPersonTracking = StartPersonTrackingResponse

Request Lenses

sptJobTag :: Lens' StartPersonTracking (Maybe Text)

Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic.

sptNotificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel)

The Amazon SNS topic ARN you want Rekognition Video to publish the completion status of the people detection operation to.

sptClientRequestToken :: Lens' StartPersonTracking (Maybe Text)

Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

sptVideo :: Lens' StartPersonTracking Video

The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

Destructuring the Response

startPersonTrackingResponse

Arguments

:: Int

sptrsResponseStatus

-> StartPersonTrackingResponse

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

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

• sptrsJobId - The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking .
• sptrsResponseStatus - -- | The response status code.

data StartPersonTrackingResponse

See: startPersonTrackingResponse smart constructor.

Instances

Eq StartPersonTrackingResponse

Methods

(==) :: StartPersonTrackingResponse -> StartPersonTrackingResponse -> Bool

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

Data StartPersonTrackingResponse

Methods

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

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

toConstr :: StartPersonTrackingResponse -> Constr

dataTypeOf :: StartPersonTrackingResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartPersonTrackingResponse

Methods

readsPrec :: Int -> ReadS StartPersonTrackingResponse

readList :: ReadS [StartPersonTrackingResponse]

readPrec :: ReadPrec StartPersonTrackingResponse

readListPrec :: ReadPrec [StartPersonTrackingResponse]

Show StartPersonTrackingResponse

Methods

showsPrec :: Int -> StartPersonTrackingResponse -> ShowS

show :: StartPersonTrackingResponse -> String

showList :: [StartPersonTrackingResponse] -> ShowS

Generic StartPersonTrackingResponse

Associated Types

type Rep StartPersonTrackingResponse :: * -> *

Methods

from :: StartPersonTrackingResponse -> Rep StartPersonTrackingResponse x

to :: Rep StartPersonTrackingResponse x -> StartPersonTrackingResponse

NFData StartPersonTrackingResponse

Methods

rnf :: StartPersonTrackingResponse -> ()

type Rep StartPersonTrackingResponse

type Rep StartPersonTrackingResponse = D1 * (MetaData "StartPersonTrackingResponse" "Network.AWS.Rekognition.StartPersonTracking" "amazonka-rekognition-1.6.0-3jgXZy5HWud2mYhTRx5OTT" False) (C1 * (MetaCons "StartPersonTrackingResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sptrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sptrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sptrsJobId :: Lens' StartPersonTrackingResponse (Maybe Text)

The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking .

sptrsResponseStatus :: Lens' StartPersonTrackingResponse Int

• - | The response status code.