blib/lib/Paws/Rekognition/StartSegmentDetection.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::StartSegmentDetection;
3 use Moose;
4 has ClientRequestToken => (is => 'ro', isa => 'Str');
5 has Filters => (is => 'ro', isa => 'Paws::Rekognition::StartSegmentDetectionFilters');
6 has JobTag => (is => 'ro', isa => 'Str');
7 has NotificationChannel => (is => 'ro', isa => 'Paws::Rekognition::NotificationChannel');
8 has SegmentTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
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 => 'StartSegmentDetection');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Rekognition::StartSegmentDetectionResponse');
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::StartSegmentDetection - Arguments for method StartSegmentDetection on L<Paws::Rekognition>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method StartSegmentDetection on the
27 L<Amazon Rekognition|Paws::Rekognition> service. Use the attributes of this class
28 as arguments to method StartSegmentDetection.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSegmentDetection.
31  
32 =head1 SYNOPSIS
33  
34 my $rekognition = Paws->service('Rekognition');
35 my $StartSegmentDetectionResponse = $rekognition->StartSegmentDetection(
36 SegmentTypes => [
37 'TECHNICAL_CUE', ... # values: TECHNICAL_CUE, SHOT
38 ],
39 Video => {
40 S3Object => {
41 Bucket => 'MyS3Bucket', # min: 3, max: 255; OPTIONAL
42 Name => 'MyS3ObjectName', # min: 1, max: 1024; OPTIONAL
43 Version => 'MyS3ObjectVersion', # min: 1, max: 1024; OPTIONAL
44 }, # OPTIONAL
45 },
46 ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
47 Filters => {
48 ShotFilter => {
49 MinSegmentConfidence => 1.0, # min: 50, max: 100; OPTIONAL
50 }, # OPTIONAL
51 TechnicalCueFilter => {
52 MinSegmentConfidence => 1.0, # min: 50, max: 100; OPTIONAL
53 }, # OPTIONAL
54 }, # OPTIONAL
55 JobTag => 'MyJobTag', # OPTIONAL
56 NotificationChannel => {
57 RoleArn => 'MyRoleArn',
58 SNSTopicArn => 'MySNSTopicArn',
59  
60 }, # OPTIONAL
61 );
62  
63 # Results:
64 my $JobId = $StartSegmentDetectionResponse->JobId;
65  
66 # Returns a L<Paws::Rekognition::StartSegmentDetectionResponse> object.
67  
68 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.
69 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rekognition/StartSegmentDetection>
70  
71 =head1 ATTRIBUTES
72  
73  
74 =head2 ClientRequestToken => Str
75  
76 Idempotent token used to identify the start request. If you use the
77 same token with multiple C<StartSegmentDetection> requests, the same
78 C<JobId> is returned. Use C<ClientRequestToken> to prevent the same job
79 from being accidently started more than once.
80  
81  
82  
83 =head2 Filters => L<Paws::Rekognition::StartSegmentDetectionFilters>
84  
85 Filters for technical cue or shot detection.
86  
87  
88  
89 =head2 JobTag => Str
90  
91 An identifier you specify that's returned in the completion
92 notification that's published to your Amazon Simple Notification
93 Service topic. For example, you can use C<JobTag> to group related jobs
94 and identify them in the completion notification.
95  
96  
97  
98 =head2 NotificationChannel => L<Paws::Rekognition::NotificationChannel>
99  
100 The ARN of the Amazon SNS topic to which you want Amazon Rekognition
101 Video to publish the completion status of the segment detection
102 operation.
103  
104  
105  
106 =head2 B<REQUIRED> SegmentTypes => ArrayRef[Str|Undef]
107  
108 An array of segment types to detect in the video. Valid values are
109 TECHNICAL_CUE and SHOT.
110  
111  
112  
113 =head2 B<REQUIRED> Video => L<Paws::Rekognition::Video>
114  
115  
116  
117  
118  
119  
120 =head1 SEE ALSO
121  
122 This class forms part of L<Paws>, documenting arguments for method StartSegmentDetection in L<Paws::Rekognition>
123  
124 =head1 BUGS and CONTRIBUTIONS
125  
126 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
127  
128 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
129  
130 =cut
131