amazonka-rekognition-2.0: Amazon Rekognition SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Rekognition.StartPersonTracking

Description

Starts the asynchronous tracking of a person's path in a stored video.

Amazon Rekognition Video can track the path of people 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 GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

Synopsis

Creating a Request

data StartPersonTracking Source #

See: newStartPersonTracking smart constructor.

Constructors

StartPersonTracking' 

Fields

  • clientRequestToken :: 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.

  • jobTag :: Maybe Text

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

  • notificationChannel :: Maybe NotificationChannel

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

  • video :: Video

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

Instances

Instances details
ToJSON StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

toJSON :: StartPersonTracking -> Value #

toEncoding :: StartPersonTracking -> Encoding #

toJSONList :: [StartPersonTracking] -> Value #

toEncodingList :: [StartPersonTracking] -> Encoding #

ToHeaders StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

toHeaders :: StartPersonTracking -> [Header] #

ToPath StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

toPath :: StartPersonTracking -> ByteString #

ToQuery StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

toQuery :: StartPersonTracking -> QueryString #

AWSRequest StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Associated Types

type AWSResponse StartPersonTracking #

Methods

request :: (Service -> Service) -> StartPersonTracking -> Request StartPersonTracking #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartPersonTracking -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartPersonTracking))) #

Generic StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Associated Types

type Rep StartPersonTracking :: Type -> Type #

Methods

from :: StartPersonTracking -> Rep StartPersonTracking x #

to :: Rep StartPersonTracking x -> StartPersonTracking #

Read StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

readsPrec :: Int -> ReadS StartPersonTracking #

readList :: ReadS [StartPersonTracking] #

readPrec :: ReadPrec StartPersonTracking #

readListPrec :: ReadPrec [StartPersonTracking] #

Show StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

showsPrec :: Int -> StartPersonTracking -> ShowS #

show :: StartPersonTracking -> String #

showList :: [StartPersonTracking] -> ShowS #

NFData StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

rnf :: StartPersonTracking -> () #

Eq StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

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

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

Hashable StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

hashWithSalt :: Int -> StartPersonTracking -> Int #

hash :: StartPersonTracking -> Int #

type AWSResponse StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

type AWSResponse StartPersonTracking = StartPersonTrackingResponse
type Rep StartPersonTracking Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

type Rep StartPersonTracking = D1 ('MetaData "StartPersonTracking" "Amazonka.Rekognition.StartPersonTracking" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "StartPersonTracking'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "notificationChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationChannel)) :*: S1 ('MetaSel ('Just "video") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Video))))

newStartPersonTracking Source #

Arguments

:: Video

$sel:video:StartPersonTracking'

-> StartPersonTracking 

Create a value of StartPersonTracking with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientRequestToken:StartPersonTracking', startPersonTracking_clientRequestToken - 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.

$sel:jobTag:StartPersonTracking', startPersonTracking_jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

$sel:notificationChannel:StartPersonTracking', startPersonTracking_notificationChannel - The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

$sel:video:StartPersonTracking', startPersonTracking_video - The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

Request Lenses

startPersonTracking_clientRequestToken :: Lens' StartPersonTracking (Maybe Text) Source #

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.

startPersonTracking_jobTag :: Lens' StartPersonTracking (Maybe Text) Source #

An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

startPersonTracking_notificationChannel :: Lens' StartPersonTracking (Maybe NotificationChannel) Source #

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

startPersonTracking_video :: Lens' StartPersonTracking Video Source #

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

Destructuring the Response

data StartPersonTrackingResponse Source #

See: newStartPersonTrackingResponse smart constructor.

Constructors

StartPersonTrackingResponse' 

Fields

  • jobId :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Associated Types

type Rep StartPersonTrackingResponse :: Type -> Type #

Methods

from :: StartPersonTrackingResponse -> Rep StartPersonTrackingResponse x #

to :: Rep StartPersonTrackingResponse x -> StartPersonTrackingResponse #

Read StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

readsPrec :: Int -> ReadS StartPersonTrackingResponse #

readList :: ReadS [StartPersonTrackingResponse] #

readPrec :: ReadPrec StartPersonTrackingResponse #

readListPrec :: ReadPrec [StartPersonTrackingResponse] #

Show StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

showsPrec :: Int -> StartPersonTrackingResponse -> ShowS #

show :: StartPersonTrackingResponse -> String #

showList :: [StartPersonTrackingResponse] -> ShowS #

NFData StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

rnf :: StartPersonTrackingResponse -> () #

Eq StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

Methods

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

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

type Rep StartPersonTrackingResponse Source # 
Instance details

Defined in Amazonka.Rekognition.StartPersonTracking

type Rep StartPersonTrackingResponse = D1 ('MetaData "StartPersonTrackingResponse" "Amazonka.Rekognition.StartPersonTracking" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "StartPersonTrackingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartPersonTrackingResponse Source #

Arguments

:: Int

$sel:httpStatus:StartPersonTrackingResponse'

-> StartPersonTrackingResponse 

Create a value of StartPersonTrackingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:StartPersonTrackingResponse', startPersonTrackingResponse_jobId - The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.

$sel:httpStatus:StartPersonTrackingResponse', startPersonTrackingResponse_httpStatus - The response's http status code.

Response Lenses

startPersonTrackingResponse_jobId :: Lens' StartPersonTrackingResponse (Maybe Text) Source #

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

startPersonTrackingResponse_httpStatus :: Lens' StartPersonTrackingResponse Int Source #

The response's http status code.