File Coverage

blib/lib/Paws/Rekognition/IndexFaces.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::IndexFaces;
3 1     1   277 use Moose;
  1         3  
  1         7  
4             has CollectionId => (is => 'ro', isa => 'Str', required => 1);
5             has DetectionAttributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6             has ExternalImageId => (is => 'ro', isa => 'Str');
7             has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1);
8              
9 1     1   5417 use MooseX::ClassAttribute;
  1         3  
  1         10  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'IndexFaces');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::IndexFacesResponse');
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::IndexFaces - Arguments for method IndexFaces on Paws::Rekognition
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method IndexFaces on the
25             Amazon Rekognition service. Use the attributes of this class
26             as arguments to method IndexFaces.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to IndexFaces.
29              
30             As an example:
31              
32             $service_obj->IndexFaces(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             The ID of an existing collection to which you want to add the faces
42             that are detected in the input images.
43              
44              
45              
46             =head2 DetectionAttributes => ArrayRef[Str|Undef]
47              
48             An array of facial attributes that you want to be returned. This can be
49             the default list of attributes or all attributes. If you don't specify
50             a value for C<Attributes> or if you specify C<["DEFAULT"]>, the API
51             returns the following subset of facial attributes: C<BoundingBox>,
52             C<Confidence>, C<Pose>, C<Quality> and C<Landmarks>. If you provide
53             C<["ALL"]>, all facial attributes are returned but the operation will
54             take longer to complete.
55              
56             If you provide both, C<["ALL", "DEFAULT"]>, the service uses a logical
57             AND operator to determine which attributes to return (in this case, all
58             attributes).
59              
60              
61              
62             =head2 ExternalImageId => Str
63              
64             ID you want to assign to all the faces detected in the image.
65              
66              
67              
68             =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image>
69              
70             The input image as bytes or an S3 object.
71              
72              
73              
74              
75             =head1 SEE ALSO
76              
77             This class forms part of L<Paws>, documenting arguments for method IndexFaces in L<Paws::Rekognition>
78              
79             =head1 BUGS and CONTRIBUTIONS
80              
81             The source code is located here: https://github.com/pplu/aws-sdk-perl
82              
83             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
84              
85             =cut
86