File Coverage

blib/lib/Paws/Rekognition/SearchFaces.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Rekognition::SearchFaces;
3 1     1   292 use Moose;
  1         3  
  1         5  
4             has CollectionId => (is => 'ro', isa => 'Str', required => 1);
5             has FaceId => (is => 'ro', isa => 'Str', required => 1);
6             has FaceMatchThreshold => (is => 'ro', isa => 'Num');
7             has MaxFaces => (is => 'ro', isa => 'Int');
8              
9 1     1   5354 use MooseX::ClassAttribute;
  1         4  
  1         8  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchFaces');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::SearchFacesResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::Rekognition::SearchFaces - Arguments for method SearchFaces on Paws::Rekognition
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method SearchFaces on the
25             Amazon Rekognition service. Use the attributes of this class
26             as arguments to method SearchFaces.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchFaces.
29              
30             As an example:
31              
32             $service_obj->SearchFaces(Att1 => $value1, Att2 => $value2, ...);
33              
34             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> CollectionId => Str
40              
41             ID of the collection the face belongs to.
42              
43              
44              
45             =head2 B<REQUIRED> FaceId => Str
46              
47             ID of a face to find matches for in the collection.
48              
49              
50              
51             =head2 FaceMatchThreshold => Num
52              
53             Optional value specifying the minimum confidence in the face match to
54             return. For example, don't return any matches where confidence in
55             matches is less than 70%.
56              
57              
58              
59             =head2 MaxFaces => Int
60              
61             Maximum number of faces to return. The operation returns the maximum
62             number of faces with the highest confidence in the match.
63              
64              
65              
66              
67             =head1 SEE ALSO
68              
69             This class forms part of L<Paws>, documenting arguments for method SearchFaces in L<Paws::Rekognition>
70              
71             =head1 BUGS and CONTRIBUTIONS
72              
73             The source code is located here: https://github.com/pplu/aws-sdk-perl
74              
75             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
76              
77             =cut
78