File Coverage

blib/lib/Paws/ElasticTranscoder.pm
Criterion Covered Total %
statement 7 133 5.2
branch 0 16 0.0
condition n/a
subroutine 3 27 11.1
pod 21 25 84.0
total 31 201 15.4


line stmt bran cond sub pod time code
1             package Paws::ElasticTranscoder;
2 1     1   7806 use Moose;
  1     1   3  
  1         13  
  1         1836  
  1         2  
  1         7  
3 6     6 0 23 sub service { 'elastictranscoder' }
4 0     0 0   sub version { '2012-09-25' }
5 0     0 0   sub flattened_arrays { 0 }
6             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
7             has retry => (is => 'ro', isa => 'HashRef', default => sub {
8             { base => 'rand', type => 'exponential', growth_factor => 2 }
9             });
10             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
11             ] });
12              
13             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller', 'Paws::Net::RestJsonResponse';
14              
15            
16             sub CancelJob {
17 0     0 1   my $self = shift;
18 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::CancelJob', @_);
19 0           return $self->caller->do_call($self, $call_object);
20             }
21             sub CreateJob {
22 0     0 1   my $self = shift;
23 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::CreateJob', @_);
24 0           return $self->caller->do_call($self, $call_object);
25             }
26             sub CreatePipeline {
27 0     0 1   my $self = shift;
28 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::CreatePipeline', @_);
29 0           return $self->caller->do_call($self, $call_object);
30             }
31             sub CreatePreset {
32 0     0 1   my $self = shift;
33 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::CreatePreset', @_);
34 0           return $self->caller->do_call($self, $call_object);
35             }
36             sub DeletePipeline {
37 0     0 1   my $self = shift;
38 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::DeletePipeline', @_);
39 0           return $self->caller->do_call($self, $call_object);
40             }
41             sub DeletePreset {
42 0     0 1   my $self = shift;
43 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::DeletePreset', @_);
44 0           return $self->caller->do_call($self, $call_object);
45             }
46             sub ListJobsByPipeline {
47 0     0 1   my $self = shift;
48 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ListJobsByPipeline', @_);
49 0           return $self->caller->do_call($self, $call_object);
50             }
51             sub ListJobsByStatus {
52 0     0 1   my $self = shift;
53 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ListJobsByStatus', @_);
54 0           return $self->caller->do_call($self, $call_object);
55             }
56             sub ListPipelines {
57 0     0 1   my $self = shift;
58 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ListPipelines', @_);
59 0           return $self->caller->do_call($self, $call_object);
60             }
61             sub ListPresets {
62 0     0 1   my $self = shift;
63 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ListPresets', @_);
64 0           return $self->caller->do_call($self, $call_object);
65             }
66             sub ReadJob {
67 0     0 1   my $self = shift;
68 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ReadJob', @_);
69 0           return $self->caller->do_call($self, $call_object);
70             }
71             sub ReadPipeline {
72 0     0 1   my $self = shift;
73 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ReadPipeline', @_);
74 0           return $self->caller->do_call($self, $call_object);
75             }
76             sub ReadPreset {
77 0     0 1   my $self = shift;
78 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::ReadPreset', @_);
79 0           return $self->caller->do_call($self, $call_object);
80             }
81             sub TestRole {
82 0     0 1   my $self = shift;
83 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::TestRole', @_);
84 0           return $self->caller->do_call($self, $call_object);
85             }
86             sub UpdatePipeline {
87 0     0 1   my $self = shift;
88 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::UpdatePipeline', @_);
89 0           return $self->caller->do_call($self, $call_object);
90             }
91             sub UpdatePipelineNotifications {
92 0     0 1   my $self = shift;
93 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::UpdatePipelineNotifications', @_);
94 0           return $self->caller->do_call($self, $call_object);
95             }
96             sub UpdatePipelineStatus {
97 0     0 1   my $self = shift;
98 0           my $call_object = $self->new_with_coercions('Paws::ElasticTranscoder::UpdatePipelineStatus', @_);
99 0           return $self->caller->do_call($self, $call_object);
100             }
101            
102             sub ListAllJobsByPipeline {
103 0     0 1   my $self = shift;
104              
105 0 0         my $callback = shift @_ if (ref($_[0]) eq 'CODE');
106 0           my $result = $self->ListJobsByPipeline(@_);
107 0           my $next_result = $result;
108              
109 0 0         if (not defined $callback) {
110 0           while ($next_result->NextPageToken) {
111 0           $next_result = $self->ListJobsByPipeline(@_, PageToken => $next_result->NextPageToken);
112 0           push @{ $result->Jobs }, @{ $next_result->Jobs };
  0            
  0            
113             }
114 0           return $result;
115             } else {
116 0           while ($result->NextPageToken) {
117 0           $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
  0            
118 0           $result = $self->ListJobsByPipeline(@_, PageToken => $result->NextPageToken);
119             }
120 0           $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
  0            
121             }
122              
123             return undef
124 0           }
125             sub ListAllJobsByStatus {
126 0     0 1   my $self = shift;
127              
128 0 0         my $callback = shift @_ if (ref($_[0]) eq 'CODE');
129 0           my $result = $self->ListJobsByStatus(@_);
130 0           my $next_result = $result;
131              
132 0 0         if (not defined $callback) {
133 0           while ($next_result->NextPageToken) {
134 0           $next_result = $self->ListJobsByStatus(@_, PageToken => $next_result->NextPageToken);
135 0           push @{ $result->Jobs }, @{ $next_result->Jobs };
  0            
  0            
136             }
137 0           return $result;
138             } else {
139 0           while ($result->NextPageToken) {
140 0           $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
  0            
141 0           $result = $self->ListJobsByStatus(@_, PageToken => $result->NextPageToken);
142             }
143 0           $callback->($_ => 'Jobs') foreach (@{ $result->Jobs });
  0            
144             }
145              
146             return undef
147 0           }
148             sub ListAllPipelines {
149 0     0 1   my $self = shift;
150              
151 0 0         my $callback = shift @_ if (ref($_[0]) eq 'CODE');
152 0           my $result = $self->ListPipelines(@_);
153 0           my $next_result = $result;
154              
155 0 0         if (not defined $callback) {
156 0           while ($next_result->NextPageToken) {
157 0           $next_result = $self->ListPipelines(@_, PageToken => $next_result->NextPageToken);
158 0           push @{ $result->Pipelines }, @{ $next_result->Pipelines };
  0            
  0            
159             }
160 0           return $result;
161             } else {
162 0           while ($result->NextPageToken) {
163 0           $callback->($_ => 'Pipelines') foreach (@{ $result->Pipelines });
  0            
164 0           $result = $self->ListPipelines(@_, PageToken => $result->NextPageToken);
165             }
166 0           $callback->($_ => 'Pipelines') foreach (@{ $result->Pipelines });
  0            
167             }
168              
169             return undef
170 0           }
171             sub ListAllPresets {
172 0     0 1   my $self = shift;
173              
174 0 0         my $callback = shift @_ if (ref($_[0]) eq 'CODE');
175 0           my $result = $self->ListPresets(@_);
176 0           my $next_result = $result;
177              
178 0 0         if (not defined $callback) {
179 0           while ($next_result->NextPageToken) {
180 0           $next_result = $self->ListPresets(@_, PageToken => $next_result->NextPageToken);
181 0           push @{ $result->Presets }, @{ $next_result->Presets };
  0            
  0            
182             }
183 0           return $result;
184             } else {
185 0           while ($result->NextPageToken) {
186 0           $callback->($_ => 'Presets') foreach (@{ $result->Presets });
  0            
187 0           $result = $self->ListPresets(@_, PageToken => $result->NextPageToken);
188             }
189 0           $callback->($_ => 'Presets') foreach (@{ $result->Presets });
  0            
190             }
191              
192             return undef
193 0           }
194              
195              
196 0     0 0   sub operations { qw/CancelJob CreateJob CreatePipeline CreatePreset DeletePipeline DeletePreset ListJobsByPipeline ListJobsByStatus ListPipelines ListPresets ReadJob ReadPipeline ReadPreset TestRole UpdatePipeline UpdatePipelineNotifications UpdatePipelineStatus / }
197              
198             1;
199              
200             ### main pod documentation begin ###
201              
202             =head1 NAME
203              
204             Paws::ElasticTranscoder - Perl Interface to AWS Amazon Elastic Transcoder
205              
206             =head1 SYNOPSIS
207              
208             use Paws;
209              
210             my $obj = Paws->service('ElasticTranscoder');
211             my $res = $obj->Method(
212             Arg1 => $val1,
213             Arg2 => [ 'V1', 'V2' ],
214             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
215             # of the arguments type
216             Arg3 => { Att1 => 'Val1' },
217             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
218             # the constructor of the arguments type
219             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
220             );
221              
222             =head1 DESCRIPTION
223              
224             AWS Elastic Transcoder Service
225              
226             The AWS Elastic Transcoder Service.
227              
228             =head1 METHODS
229              
230             =head2 CancelJob(Id => Str)
231              
232             Each argument is described in detail in: L<Paws::ElasticTranscoder::CancelJob>
233              
234             Returns: a L<Paws::ElasticTranscoder::CancelJobResponse> instance
235              
236             The CancelJob operation cancels an unfinished job.
237              
238             You can only cancel a job that has a status of C<Submitted>. To prevent
239             a pipeline from starting to process a job while you're getting the job
240             identifier, use UpdatePipelineStatus to temporarily pause the pipeline.
241              
242              
243             =head2 CreateJob(PipelineId => Str, [Input => L<Paws::ElasticTranscoder::JobInput>, Inputs => ArrayRef[L<Paws::ElasticTranscoder::JobInput>], Output => L<Paws::ElasticTranscoder::CreateJobOutput>, OutputKeyPrefix => Str, Outputs => ArrayRef[L<Paws::ElasticTranscoder::CreateJobOutput>], Playlists => ArrayRef[L<Paws::ElasticTranscoder::CreateJobPlaylist>], UserMetadata => L<Paws::ElasticTranscoder::UserMetadata>])
244              
245             Each argument is described in detail in: L<Paws::ElasticTranscoder::CreateJob>
246              
247             Returns: a L<Paws::ElasticTranscoder::CreateJobResponse> instance
248              
249             When you create a job, Elastic Transcoder returns JSON data that
250             includes the values that you specified plus information about the job
251             that is created.
252              
253             If you have specified more than one output for your jobs (for example,
254             one output for the Kindle Fire and another output for the Apple iPhone
255             4s), you currently must use the Elastic Transcoder API to list the jobs
256             (as opposed to the AWS Console).
257              
258              
259             =head2 CreatePipeline(InputBucket => Str, Name => Str, Role => Str, [AwsKmsKeyArn => Str, ContentConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>, Notifications => L<Paws::ElasticTranscoder::Notifications>, OutputBucket => Str, ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>])
260              
261             Each argument is described in detail in: L<Paws::ElasticTranscoder::CreatePipeline>
262              
263             Returns: a L<Paws::ElasticTranscoder::CreatePipelineResponse> instance
264              
265             The CreatePipeline operation creates a pipeline with settings that you
266             specify.
267              
268              
269             =head2 CreatePreset(Container => Str, Name => Str, [Audio => L<Paws::ElasticTranscoder::AudioParameters>, Description => Str, Thumbnails => L<Paws::ElasticTranscoder::Thumbnails>, Video => L<Paws::ElasticTranscoder::VideoParameters>])
270              
271             Each argument is described in detail in: L<Paws::ElasticTranscoder::CreatePreset>
272              
273             Returns: a L<Paws::ElasticTranscoder::CreatePresetResponse> instance
274              
275             The CreatePreset operation creates a preset with settings that you
276             specify.
277              
278             Elastic Transcoder checks the CreatePreset settings to ensure that they
279             meet Elastic Transcoder requirements and to determine whether they
280             comply with H.264 standards. If your settings are not valid for Elastic
281             Transcoder, Elastic Transcoder returns an HTTP 400 response
282             (C<ValidationException>) and does not create the preset. If the
283             settings are valid for Elastic Transcoder but aren't strictly compliant
284             with the H.264 standard, Elastic Transcoder creates the preset and
285             returns a warning message in the response. This helps you determine
286             whether your settings comply with the H.264 standard while giving you
287             greater flexibility with respect to the video that Elastic Transcoder
288             produces.
289              
290             Elastic Transcoder uses the H.264 video-compression format. For more
291             information, see the International Telecommunication Union publication
292             I<Recommendation ITU-T H.264: Advanced video coding for generic
293             audiovisual services>.
294              
295              
296             =head2 DeletePipeline(Id => Str)
297              
298             Each argument is described in detail in: L<Paws::ElasticTranscoder::DeletePipeline>
299              
300             Returns: a L<Paws::ElasticTranscoder::DeletePipelineResponse> instance
301              
302             The DeletePipeline operation removes a pipeline.
303              
304             You can only delete a pipeline that has never been used or that is not
305             currently in use (doesn't contain any active jobs). If the pipeline is
306             currently in use, C<DeletePipeline> returns an error.
307              
308              
309             =head2 DeletePreset(Id => Str)
310              
311             Each argument is described in detail in: L<Paws::ElasticTranscoder::DeletePreset>
312              
313             Returns: a L<Paws::ElasticTranscoder::DeletePresetResponse> instance
314              
315             The DeletePreset operation removes a preset that you've added in an AWS
316             region.
317              
318             You can't delete the default presets that are included with Elastic
319             Transcoder.
320              
321              
322             =head2 ListJobsByPipeline(PipelineId => Str, [Ascending => Str, PageToken => Str])
323              
324             Each argument is described in detail in: L<Paws::ElasticTranscoder::ListJobsByPipeline>
325              
326             Returns: a L<Paws::ElasticTranscoder::ListJobsByPipelineResponse> instance
327              
328             The ListJobsByPipeline operation gets a list of the jobs currently in a
329             pipeline.
330              
331             Elastic Transcoder returns all of the jobs currently in the specified
332             pipeline. The response body contains one element for each job that
333             satisfies the search criteria.
334              
335              
336             =head2 ListJobsByStatus(Status => Str, [Ascending => Str, PageToken => Str])
337              
338             Each argument is described in detail in: L<Paws::ElasticTranscoder::ListJobsByStatus>
339              
340             Returns: a L<Paws::ElasticTranscoder::ListJobsByStatusResponse> instance
341              
342             The ListJobsByStatus operation gets a list of jobs that have a
343             specified status. The response body contains one element for each job
344             that satisfies the search criteria.
345              
346              
347             =head2 ListPipelines([Ascending => Str, PageToken => Str])
348              
349             Each argument is described in detail in: L<Paws::ElasticTranscoder::ListPipelines>
350              
351             Returns: a L<Paws::ElasticTranscoder::ListPipelinesResponse> instance
352              
353             The ListPipelines operation gets a list of the pipelines associated
354             with the current AWS account.
355              
356              
357             =head2 ListPresets([Ascending => Str, PageToken => Str])
358              
359             Each argument is described in detail in: L<Paws::ElasticTranscoder::ListPresets>
360              
361             Returns: a L<Paws::ElasticTranscoder::ListPresetsResponse> instance
362              
363             The ListPresets operation gets a list of the default presets included
364             with Elastic Transcoder and the presets that you've added in an AWS
365             region.
366              
367              
368             =head2 ReadJob(Id => Str)
369              
370             Each argument is described in detail in: L<Paws::ElasticTranscoder::ReadJob>
371              
372             Returns: a L<Paws::ElasticTranscoder::ReadJobResponse> instance
373              
374             The ReadJob operation returns detailed information about a job.
375              
376              
377             =head2 ReadPipeline(Id => Str)
378              
379             Each argument is described in detail in: L<Paws::ElasticTranscoder::ReadPipeline>
380              
381             Returns: a L<Paws::ElasticTranscoder::ReadPipelineResponse> instance
382              
383             The ReadPipeline operation gets detailed information about a pipeline.
384              
385              
386             =head2 ReadPreset(Id => Str)
387              
388             Each argument is described in detail in: L<Paws::ElasticTranscoder::ReadPreset>
389              
390             Returns: a L<Paws::ElasticTranscoder::ReadPresetResponse> instance
391              
392             The ReadPreset operation gets detailed information about a preset.
393              
394              
395             =head2 TestRole(InputBucket => Str, OutputBucket => Str, Role => Str, Topics => ArrayRef[Str|Undef])
396              
397             Each argument is described in detail in: L<Paws::ElasticTranscoder::TestRole>
398              
399             Returns: a L<Paws::ElasticTranscoder::TestRoleResponse> instance
400              
401             The TestRole operation tests the IAM role used to create the pipeline.
402              
403             The C<TestRole> action lets you determine whether the IAM role you are
404             using has sufficient permissions to let Elastic Transcoder perform
405             tasks associated with the transcoding process. The action attempts to
406             assume the specified IAM role, checks read access to the input and
407             output buckets, and tries to send a test notification to Amazon SNS
408             topics that you specify.
409              
410              
411             =head2 UpdatePipeline(Id => Str, [AwsKmsKeyArn => Str, ContentConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>, InputBucket => Str, Name => Str, Notifications => L<Paws::ElasticTranscoder::Notifications>, Role => Str, ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>])
412              
413             Each argument is described in detail in: L<Paws::ElasticTranscoder::UpdatePipeline>
414              
415             Returns: a L<Paws::ElasticTranscoder::UpdatePipelineResponse> instance
416              
417             Use the C<UpdatePipeline> operation to update settings for a pipeline.
418              
419             When you change pipeline settings, your changes take effect
420             immediately. Jobs that you have already submitted and that Elastic
421             Transcoder has not started to process are affected in addition to jobs
422             that you submit after you change settings.
423              
424              
425             =head2 UpdatePipelineNotifications(Id => Str, Notifications => L<Paws::ElasticTranscoder::Notifications>)
426              
427             Each argument is described in detail in: L<Paws::ElasticTranscoder::UpdatePipelineNotifications>
428              
429             Returns: a L<Paws::ElasticTranscoder::UpdatePipelineNotificationsResponse> instance
430              
431             With the UpdatePipelineNotifications operation, you can update Amazon
432             Simple Notification Service (Amazon SNS) notifications for a pipeline.
433              
434             When you update notifications for a pipeline, Elastic Transcoder
435             returns the values that you specified in the request.
436              
437              
438             =head2 UpdatePipelineStatus(Id => Str, Status => Str)
439              
440             Each argument is described in detail in: L<Paws::ElasticTranscoder::UpdatePipelineStatus>
441              
442             Returns: a L<Paws::ElasticTranscoder::UpdatePipelineStatusResponse> instance
443              
444             The UpdatePipelineStatus operation pauses or reactivates a pipeline, so
445             that the pipeline stops or restarts the processing of jobs.
446              
447             Changing the pipeline status is useful if you want to cancel one or
448             more jobs. You can't cancel jobs after Elastic Transcoder has started
449             processing them; if you pause the pipeline to which you submitted the
450             jobs, you have more time to get the job IDs for the jobs that you want
451             to cancel, and to send a CancelJob request.
452              
453              
454              
455              
456             =head1 PAGINATORS
457              
458             Paginator methods are helpers that repetively call methods that return partial results
459              
460             =head2 ListAllJobsByPipeline(sub { },PipelineId => Str, [Ascending => Str, PageToken => Str])
461              
462             =head2 ListAllJobsByPipeline(PipelineId => Str, [Ascending => Str, PageToken => Str])
463              
464              
465             If passed a sub as first parameter, it will call the sub for each element found in :
466              
467             - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter
468              
469             If not, it will return a a L<Paws::ElasticTranscoder::ListJobsByPipelineResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
470              
471              
472             =head2 ListAllJobsByStatus(sub { },Status => Str, [Ascending => Str, PageToken => Str])
473              
474             =head2 ListAllJobsByStatus(Status => Str, [Ascending => Str, PageToken => Str])
475              
476              
477             If passed a sub as first parameter, it will call the sub for each element found in :
478              
479             - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter
480              
481             If not, it will return a a L<Paws::ElasticTranscoder::ListJobsByStatusResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
482              
483              
484             =head2 ListAllPipelines(sub { },[Ascending => Str, PageToken => Str])
485              
486             =head2 ListAllPipelines([Ascending => Str, PageToken => Str])
487              
488              
489             If passed a sub as first parameter, it will call the sub for each element found in :
490              
491             - Pipelines, passing the object as the first parameter, and the string 'Pipelines' as the second parameter
492              
493             If not, it will return a a L<Paws::ElasticTranscoder::ListPipelinesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
494              
495              
496             =head2 ListAllPresets(sub { },[Ascending => Str, PageToken => Str])
497              
498             =head2 ListAllPresets([Ascending => Str, PageToken => Str])
499              
500              
501             If passed a sub as first parameter, it will call the sub for each element found in :
502              
503             - Presets, passing the object as the first parameter, and the string 'Presets' as the second parameter
504              
505             If not, it will return a a L<Paws::ElasticTranscoder::ListPresetsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
506              
507              
508              
509              
510              
511             =head1 SEE ALSO
512              
513             This service class forms part of L<Paws>
514              
515             =head1 BUGS and CONTRIBUTIONS
516              
517             The source code is located here: https://github.com/pplu/aws-sdk-perl
518              
519             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
520              
521             =cut
522