Skip to content

/AWS1/CL_REKGETFACESEARCHRSP

GetFaceSearchResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_jobstatus TYPE /AWS1/REKVIDEOJOBSTATUS /AWS1/REKVIDEOJOBSTATUS

The current status of the face search job.

iv_statusmessage TYPE /AWS1/REKSTATUSMESSAGE /AWS1/REKSTATUSMESSAGE

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

iv_nexttoken TYPE /AWS1/REKPAGINATIONTOKEN /AWS1/REKPAGINATIONTOKEN

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

io_videometadata TYPE REF TO /AWS1/CL_REKVIDEOMETADATA /AWS1/CL_REKVIDEOMETADATA

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

it_persons TYPE /AWS1/CL_REKPERSONMATCH=>TT_PERSONMATCHES TT_PERSONMATCHES

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

iv_jobid TYPE /AWS1/REKJOBID /AWS1/REKJOBID

Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.

io_video TYPE REF TO /AWS1/CL_REKVIDEO /AWS1/CL_REKVIDEO

Video

iv_jobtag TYPE /AWS1/REKJOBTAG /AWS1/REKJOBTAG

A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.


Queryable Attributes

JobStatus

The current status of the face search job.

Accessible with the following methods

Method Description
GET_JOBSTATUS() Getter for JOBSTATUS, with configurable default
ASK_JOBSTATUS() Getter for JOBSTATUS w/ exceptions if field has no value
HAS_JOBSTATUS() Determine if JOBSTATUS has a value

StatusMessage

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

Accessible with the following methods

Method Description
GET_STATUSMESSAGE() Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE() Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE() Determine if STATUSMESSAGE has a value

NextToken

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

Accessible with the following methods

Method Description
GET_NEXTTOKEN() Getter for NEXTTOKEN, with configurable default
ASK_NEXTTOKEN() Getter for NEXTTOKEN w/ exceptions if field has no value
HAS_NEXTTOKEN() Determine if NEXTTOKEN has a value

VideoMetadata

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

Accessible with the following methods

Method Description
GET_VIDEOMETADATA() Getter for VIDEOMETADATA

Persons

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

Accessible with the following methods

Method Description
GET_PERSONS() Getter for PERSONS, with configurable default
ASK_PERSONS() Getter for PERSONS w/ exceptions if field has no value
HAS_PERSONS() Determine if PERSONS has a value

JobId

Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.

Accessible with the following methods

Method Description
GET_JOBID() Getter for JOBID, with configurable default
ASK_JOBID() Getter for JOBID w/ exceptions if field has no value
HAS_JOBID() Determine if JOBID has a value

Video

Video

Accessible with the following methods

Method Description
GET_VIDEO() Getter for VIDEO

JobTag

A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Accessible with the following methods

Method Description
GET_JOBTAG() Getter for JOBTAG, with configurable default
ASK_JOBTAG() Getter for JOBTAG w/ exceptions if field has no value
HAS_JOBTAG() Determine if JOBTAG has a value