File Coverage

blib/lib/Paws/Rekognition/CompareFaces.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::CompareFaces;
3 1     1   435 use Moose;
  1         4  
  1         8  
4             has SimilarityThreshold => (is => 'ro', isa => 'Num');
5             has SourceImage => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1);
6             has TargetImage => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1);
7              
8 1     1   7245 use MooseX::ClassAttribute;
  1         4  
  1         9  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CompareFaces');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::CompareFacesResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::Rekognition::CompareFaces - Arguments for method CompareFaces on Paws::Rekognition
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method CompareFaces on the
24             Amazon Rekognition service. Use the attributes of this class
25             as arguments to method CompareFaces.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CompareFaces.
28              
29             As an example:
30              
31             $service_obj->CompareFaces(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 SimilarityThreshold => Num
39              
40             The minimum level of confidence in the face matches that a match must
41             meet to be included in the C<FaceMatches> array.
42              
43              
44              
45             =head2 B<REQUIRED> SourceImage => L<Paws::Rekognition::Image>
46              
47             The source image, either as bytes or as an S3 object.
48              
49              
50              
51             =head2 B<REQUIRED> TargetImage => L<Paws::Rekognition::Image>
52              
53             The target image, either as bytes or as an S3 object.
54              
55              
56              
57              
58             =head1 SEE ALSO
59              
60             This class forms part of L<Paws>, documenting arguments for method CompareFaces in L<Paws::Rekognition>
61              
62             =head1 BUGS and CONTRIBUTIONS
63              
64             The source code is located here: https://github.com/pplu/aws-sdk-perl
65              
66             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
67              
68             =cut
69