« blib/lib/Paws/Rekognition/GetFaceSearch.pm
↑ Summary
blib/lib/Paws/Rekognition/GetLabelDetection.pm »
| 1 | |||
| 2 | package Paws::Rekognition::GetFaceSearchResponse; | ||
| 3 | use Moose; | ||
| 4 | has JobStatus => (is => 'ro', isa => 'Str'); | ||
| 5 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has Persons => (is => 'ro', isa => 'ArrayRef[Paws::Rekognition::PersonMatch]'); | ||
| 7 | has StatusMessage => (is => 'ro', isa => 'Str'); | ||
| 8 | has VideoMetadata => (is => 'ro', isa => 'Paws::Rekognition::VideoMetadata'); | ||
| 9 | |||
| 10 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Rekognition::GetFaceSearchResponse | ||
| 17 | |||
| 18 | =head1 ATTRIBUTES | ||
| 19 | |||
| 20 | |||
| 21 | =head2 JobStatus => Str | ||
| 22 | |||
| 23 | The current status of the face search job. | ||
| 24 | |||
| 25 | Valid values are: C<"IN_PROGRESS">, C<"SUCCEEDED">, C<"FAILED"> | ||
| 26 | =head2 NextToken => Str | ||
| 27 | |||
| 28 | If the response is truncated, Amazon Rekognition Video returns this | ||
| 29 | token that you can use in the subsequent request to retrieve the next | ||
| 30 | set of search results. | ||
| 31 | |||
| 32 | |||
| 33 | =head2 Persons => ArrayRef[L<Paws::Rekognition::PersonMatch>] | ||
| 34 | |||
| 35 | An array of persons, PersonMatch, in the video whose face(s) match the | ||
| 36 | face(s) in an Amazon Rekognition collection. It also includes time | ||
| 37 | information for when persons are matched in the video. You specify the | ||
| 38 | input collection in an initial call to C<StartFaceSearch>. Each | ||
| 39 | C<Persons> element includes a time the person was matched, face match | ||
| 40 | details (C<FaceMatches>) for matching faces in the collection, and | ||
| 41 | person information (C<Person>) for the matched person. | ||
| 42 | |||
| 43 | |||
| 44 | =head2 StatusMessage => Str | ||
| 45 | |||
| 46 | If the job fails, C<StatusMessage> provides a descriptive error | ||
| 47 | message. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 VideoMetadata => L<Paws::Rekognition::VideoMetadata> | ||
| 51 | |||
| 52 | Information about a video that Amazon Rekognition analyzed. | ||
| 53 | C<Videometadata> is returned in every page of paginated responses from | ||
| 54 | a Amazon Rekognition Video operation. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 _request_id => Str | ||
| 58 | |||
| 59 | |||
| 60 | =cut | ||
| 61 | |||
| 62 | 1; |