blib/lib/Paws/Rekognition/StartFaceDetection.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Rekognition::StartFaceDetection;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has FaceAttributes => (is => 'ro', isa => 'Str');
6 has JobTag => (is => 'ro', isa => 'Str');
7 has NotificationChannel => (is => 'ro', isa => 'Paws::Rekognition::NotificationChannel');
8 has Video => (is => 'ro', isa => 'Paws::Rekognition::Video', required => 1);
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartFaceDetection');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::StartFaceDetectionResponse');
14 class_has _result_key => (isa => 'Str', is => 'ro');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Rekognition::StartFaceDetection - Arguments for method StartFaceDetection on L<Paws::Rekognition>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method StartFaceDetection on the
26 L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class
27 as arguments to method StartFaceDetection.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartFaceDetection.
30  
31 =head1 SYNOPSIS
32  
33 my $rekognition = Paws->service('Rekognition');
34 my $StartFaceDetectionResponse = $rekognition->StartFaceDetection(
35 Video => {
36 S3Object => {
37 Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL
38 Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL
39 Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL
40 }, # OPTIONAL
41 },
42 ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
43 FaceAttributes => 'DEFAULT', # OPTIONAL
44 JobTag => 'MyJobTag', # OPTIONAL
45 NotificationChannel => {
46 RoleArn => 'MyRoleArn',
47 SNSTopicArn => 'MySNSTopicArn',
48  
49 }, # OPTIONAL
50 );
51  
52 # Results:
53 my $JobId = $StartFaceDetectionResponse->JobId;
54  
55 # Returns a L<Paws::Rekognition::StartFaceDetectionResponse> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/StartFaceDetection>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 ClientRequestToken => Str
64  
65 Idempotent token used to identify the start request. If you use the
66 same token with multiple C<StartFaceDetection> requests, the same
67 C<JobId> is returned. Use C<ClientRequestToken> to prevent the same job
68 from being accidently started more than once.
69  
70  
71  
72 =head2 FaceAttributes => Str
73  
74 The face attributes you want returned.
75  
76 C<DEFAULT> - The following subset of facial attributes are returned:
77 BoundingBox, Confidence, Pose, Quality and Landmarks.
78  
79 C<ALL> - All facial attributes are returned.
80  
81 Valid values are: C<"DEFAULT">, C<"ALL">
82  
83 =head2 JobTag => Str
84  
85 An identifier you specify that's returned in the completion
86 notification that's published to your Amazon Simple Notification
87 Service topic. For example, you can use C<JobTag> to group related jobs
88 and identify them in the completion notification.
89  
90  
91  
92 =head2 NotificationChannel => L<Paws::Rekognition::NotificationChannel>
93  
94 The ARN of the Amazon SNS topic to which you want Amazon Rekognition
95 Video to publish the completion status of the face detection operation.
96  
97  
98  
99 =head2 B<REQUIRED> Video => L<Paws::Rekognition::Video>
100  
101 The video in which you want to detect faces. The video must be stored
102 in an Amazon S3 bucket.
103  
104  
105  
106  
107 =head1 SEE ALSO
108  
109 This class forms part of L<Paws>, documenting arguments for method StartFaceDetection in L<Paws::Rekognition>
110  
111 =head1 BUGS and CONTRIBUTIONS
112  
113 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
114  
115 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
116  
117 =cut
118