File Coverage

blib/lib/Paws/Rekognition/DetectFaces.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::DetectFaces;
3 1     1   549 use Moose;
  1         3  
  1         9  
4             has Attributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1);
6              
7 1     1   6619 use MooseX::ClassAttribute;
  1         4  
  1         11  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DetectFaces');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::DetectFacesResponse');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::Rekognition::DetectFaces - Arguments for method DetectFaces on Paws::Rekognition
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method DetectFaces on the
23             Amazon Rekognition service. Use the attributes of this class
24             as arguments to method DetectFaces.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DetectFaces.
27              
28             As an example:
29              
30             $service_obj->DetectFaces(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 Attributes => ArrayRef[Str|Undef]
38              
39             An array of facial attributes you want to be returned. This can be the
40             default list of attributes or all attributes. If you don't specify a
41             value for C<Attributes> or if you specify C<["DEFAULT"]>, the API
42             returns the following subset of facial attributes: C<BoundingBox>,
43             C<Confidence>, C<Pose>, C<Quality> and C<Landmarks>. If you provide
44             C<["ALL"]>, all facial attributes are returned but the operation will
45             take longer to complete.
46              
47             If you provide both, C<["ALL", "DEFAULT"]>, the service uses a logical
48             AND operator to determine which attributes to return (in this case, all
49             attributes).
50              
51              
52              
53             =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image>
54              
55             The image in which you want to detect faces. You can specify a blob or
56             an S3 object.
57              
58              
59              
60              
61             =head1 SEE ALSO
62              
63             This class forms part of L<Paws>, documenting arguments for method DetectFaces in L<Paws::Rekognition>
64              
65             =head1 BUGS and CONTRIBUTIONS
66              
67             The source code is located here: https://github.com/pplu/aws-sdk-perl
68              
69             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
70              
71             =cut
72