File Coverage

blib/lib/Paws/Rekognition/Face.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Rekognition::Face;
2 1     1   294 use Moose;
  1         3  
  1         7  
3             has BoundingBox => (is => 'ro', isa => 'Paws::Rekognition::BoundingBox');
4             has Confidence => (is => 'ro', isa => 'Num');
5             has ExternalImageId => (is => 'ro', isa => 'Str');
6             has FaceId => (is => 'ro', isa => 'Str');
7             has ImageId => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Rekognition::Face
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::Rekognition::Face object:
26              
27             $service_obj->Method(Att1 => { BoundingBox => $value, ..., ImageId => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::Rekognition::Face object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->BoundingBox
35              
36             =head1 DESCRIPTION
37              
38             Describes the face properties such as the bounding box, face ID, image
39             ID of the input image, and external image ID that you assigned.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 BoundingBox => L<Paws::Rekognition::BoundingBox>
45              
46             Bounding box of the face.
47              
48              
49             =head2 Confidence => Num
50              
51             Confidence level that the bounding box contains a face (and not a
52             different object such as a tree).
53              
54              
55             =head2 ExternalImageId => Str
56              
57             Identifier that you assign to all the faces in the input image.
58              
59              
60             =head2 FaceId => Str
61              
62             Unique identifier that Amazon Rekognition assigns to the face.
63              
64              
65             =head2 ImageId => Str
66              
67             Unique identifier that Amazon Rekognition assigns to the input image.
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, describing an object used in L<Paws::Rekognition>
74              
75             =head1 BUGS and CONTRIBUTIONS
76              
77             The source code is located here: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82