« blib/lib/Paws/Rekognition/DetectCustomLabelsResponse.pm
↑ Summary
blib/lib/Paws/Rekognition/DetectFacesResponse.pm »
| 1 | |||
| 2 | package Paws::Rekognition::DetectFaces; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Image => (is => 'ro', isa => 'Paws::Rekognition::Image', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::Rekognition> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DetectFaces on the | ||
| 23 | L<Amazon Rekognition|Paws::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 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $rekognition = Paws->service('Rekognition'); | ||
| 31 | # To detect faces in an image | ||
| 32 | # This operation detects faces in an image stored in an AWS S3 bucket. | ||
| 33 | my $DetectFacesResponse = $rekognition->DetectFaces( | ||
| 34 | 'Image' => { | ||
| 35 | 'S3Object' => { | ||
| 36 | 'Bucket' => 'mybucket', | ||
| 37 | 'Name' => 'myphoto' | ||
| 38 | } | ||
| 39 | } | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $FaceDetails = $DetectFacesResponse->FaceDetails; | ||
| 44 | my $OrientationCorrection = $DetectFacesResponse->OrientationCorrection; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Rekognition::DetectFacesResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/DetectFaces> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Attributes => ArrayRef[Str|Undef] | ||
| 55 | |||
| 56 | An array of facial attributes you want to be returned. This can be the | ||
| 57 | default list of attributes or all attributes. If you don't specify a | ||
| 58 | value for C<Attributes> or if you specify C<["DEFAULT"]>, the API | ||
| 59 | returns the following subset of facial attributes: C<BoundingBox>, | ||
| 60 | C<Confidence>, C<Pose>, C<Quality>, and C<Landmarks>. If you provide | ||
| 61 | C<["ALL"]>, all facial attributes are returned, but the operation takes | ||
| 62 | longer to complete. | ||
| 63 | |||
| 64 | If you provide both, C<["ALL", "DEFAULT"]>, the service uses a logical | ||
| 65 | AND operator to determine which attributes to return (in this case, all | ||
| 66 | attributes). | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Image => L<Paws::Rekognition::Image> | ||
| 71 | |||
| 72 | The input image as base64-encoded bytes or an S3 object. If you use the | ||
| 73 | AWS CLI to call Amazon Rekognition operations, passing base64-encoded | ||
| 74 | image bytes is not supported. | ||
| 75 | |||
| 76 | If you are using an AWS SDK to call Amazon Rekognition, you might not | ||
| 77 | need to base64-encode image bytes passed using the C<Bytes> field. For | ||
| 78 | more information, see Images in the Amazon Rekognition developer guide. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method DetectFaces in L<Paws::Rekognition> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |