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

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