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

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Rekognition::GetCelebrityRecognition;
3 use Moose;
4 has JobId => (is => 'ro', isa => 'Str', required => 1);
5 has MaxResults => (is => 'ro', isa => 'Int');
6 has NextToken => (is => 'ro', isa => 'Str');
7 has SortBy => (is => 'ro', isa => 'Str');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCelebrityRecognition');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::GetCelebrityRecognitionResponse');
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::GetCelebrityRecognition - Arguments for method GetCelebrityRecognition on L<Paws::Rekognition>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method GetCelebrityRecognition on the
25 L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class
26 as arguments to method GetCelebrityRecognition.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCelebrityRecognition.
29  
30 =head1 SYNOPSIS
31  
32 my $rekognition = Paws->service('Rekognition');
33 my $GetCelebrityRecognitionResponse = $rekognition->GetCelebrityRecognition(
34 JobId => 'MyJobId',
35 MaxResults => 1, # OPTIONAL
36 NextToken => 'MyPaginationToken', # OPTIONAL
37 SortBy => 'ID', # OPTIONAL
38 );
39  
40 # Results:
41 my $Celebrities = $GetCelebrityRecognitionResponse->Celebrities;
42 my $JobStatus = $GetCelebrityRecognitionResponse->JobStatus;
43 my $NextToken = $GetCelebrityRecognitionResponse->NextToken;
44 my $StatusMessage = $GetCelebrityRecognitionResponse->StatusMessage;
45 my $VideoMetadata = $GetCelebrityRecognitionResponse->VideoMetadata;
46  
47 # Returns a L<Paws::Rekognition::GetCelebrityRecognitionResponse> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/GetCelebrityRecognition>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 B<REQUIRED> JobId => Str
56  
57 Job identifier for the required celebrity recognition analysis. You can
58 get the job identifer from a call to C<StartCelebrityRecognition>.
59  
60  
61  
62 =head2 MaxResults => Int
63  
64 Maximum number of results to return per paginated call. The largest
65 value you can specify is 1000. If you specify a value greater than
66 1000, a maximum of 1000 results is returned. The default value is 1000.
67  
68  
69  
70 =head2 NextToken => Str
71  
72 If the previous response was incomplete (because there is more
73 recognized celebrities to retrieve), Amazon Rekognition Video returns a
74 pagination token in the response. You can use this pagination token to
75 retrieve the next set of celebrities.
76  
77  
78  
79 =head2 SortBy => Str
80  
81 Sort to use for celebrities returned in C<Celebrities> field. Specify
82 C<ID> to sort by the celebrity identifier, specify C<TIMESTAMP> to sort
83 by the time the celebrity was recognized.
84  
85 Valid values are: C<"ID">, C<"TIMESTAMP">
86  
87  
88 =head1 SEE ALSO
89  
90 This class forms part of L<Paws>, documenting arguments for method GetCelebrityRecognition in L<Paws::Rekognition>
91  
92 =head1 BUGS and CONTRIBUTIONS
93  
94 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
95  
96 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
97  
98 =cut
99