blib/lib/Paws/ElasticTranscoder/CreatePipeline.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ElasticTranscoder::CreatePipeline;
3 use Moose;
4 has AwsKmsKeyArn => (is => 'ro', isa => 'Str');
5 has ContentConfig => (is => 'ro', isa => 'Paws::ElasticTranscoder::PipelineOutputConfig');
6 has InputBucket => (is => 'ro', isa => 'Str', required => 1);
7 has Name => (is => 'ro', isa => 'Str', required => 1);
8 has Notifications => (is => 'ro', isa => 'Paws::ElasticTranscoder::Notifications');
9 has OutputBucket => (is => 'ro', isa => 'Str');
10 has Role => (is => 'ro', isa => 'Str', required => 1);
11 has ThumbnailConfig => (is => 'ro', isa => 'Paws::ElasticTranscoder::PipelineOutputConfig');
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePipeline');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2012-09-25/pipelines');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticTranscoder::CreatePipelineResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::ElasticTranscoder::CreatePipeline - Arguments for method CreatePipeline on L<Paws::ElasticTranscoder>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method CreatePipeline on the
30 L<Amazon Elastic Transcoder|Paws::ElasticTranscoder> service. Use the attributes of this class
31 as arguments to method CreatePipeline.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePipeline.
34  
35 =head1 SYNOPSIS
36  
37 my $elastictranscoder = Paws->service('ElasticTranscoder');
38 my $CreatePipelineResponse = $elastictranscoder->CreatePipeline(
39 InputBucket => 'MyBucketName',
40 Name => 'MyName',
41 Role => 'MyRole',
42 AwsKmsKeyArn => 'MyKeyArn', # OPTIONAL
43 ContentConfig => {
44 Bucket => 'MyBucketName',
45 Permissions => [
46 {
47 Access => [ 'MyAccessControl', ... ], # max: 30; OPTIONAL
48 Grantee => 'MyGrantee', # min: 1, max: 255; OPTIONAL
49 GranteeType => 'MyGranteeType', # OPTIONAL
50 },
51 ...
52 ], # max: 30; OPTIONAL
53 StorageClass => 'MyStorageClass', # OPTIONAL
54 }, # OPTIONAL
55 Notifications => {
56 Completed => 'MySnsTopic', # OPTIONAL
57 Error => 'MySnsTopic', # OPTIONAL
58 Progressing => 'MySnsTopic', # OPTIONAL
59 Warning => 'MySnsTopic', # OPTIONAL
60 }, # OPTIONAL
61 OutputBucket => 'MyBucketName', # OPTIONAL
62 ThumbnailConfig => {
63 Bucket => 'MyBucketName',
64 Permissions => [
65 {
66 Access => [ 'MyAccessControl', ... ], # max: 30; OPTIONAL
67 Grantee => 'MyGrantee', # min: 1, max: 255; OPTIONAL
68 GranteeType => 'MyGranteeType', # OPTIONAL
69 },
70 ...
71 ], # max: 30; OPTIONAL
72 StorageClass => 'MyStorageClass', # OPTIONAL
73 }, # OPTIONAL
74 );
75  
76 # Results:
77 my $Pipeline = $CreatePipelineResponse->Pipeline;
78 my $Warnings = $CreatePipelineResponse->Warnings;
79  
80 # Returns a L<Paws::ElasticTranscoder::CreatePipelineResponse> object.
81  
82 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.
83 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elastictranscoder/CreatePipeline>
84  
85 =head1 ATTRIBUTES
86  
87  
88 =head2 AwsKmsKeyArn => Str
89  
90 The AWS Key Management Service (AWS KMS) key that you want to use with
91 this pipeline.
92  
93 If you use either C<s3> or C<s3-aws-kms> as your C<Encryption:Mode>,
94 you don't need to provide a key with your job because a default key,
95 known as an AWS-KMS key, is created for you automatically. You need to
96 provide an AWS-KMS key only if you want to use a non-default AWS-KMS
97 key, or if you are using an C<Encryption:Mode> of C<aes-cbc-pkcs7>,
98 C<aes-ctr>, or C<aes-gcm>.
99  
100  
101  
102 =head2 ContentConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>
103  
104 The optional C<ContentConfig> object specifies information about the
105 Amazon S3 bucket in which you want Elastic Transcoder to save
106 transcoded files and playlists: which bucket to use, which users you
107 want to have access to the files, the type of access you want users to
108 have, and the storage class that you want to assign to the files.
109  
110 If you specify values for C<ContentConfig>, you must also specify
111 values for C<ThumbnailConfig>.
112  
113 If you specify values for C<ContentConfig> and C<ThumbnailConfig>, omit
114 the C<OutputBucket> object.
115  
116 =over
117  
118 =item *
119  
120 B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to
121 save transcoded files and playlists.
122  
123 =item *
124  
125 B<Permissions> (Optional): The Permissions object specifies which users
126 you want to have access to transcoded files and the type of access you
127 want them to have. You can grant permissions to a maximum of 30 users
128 and/or predefined Amazon S3 groups.
129  
130 =item *
131  
132 B<Grantee Type>: Specify the type of value that appears in the
133 C<Grantee> object:
134  
135 =over
136  
137 =item *
138  
139 B<Canonical>: The value in the C<Grantee> object is either the
140 canonical user ID for an AWS account or an origin access identity for
141 an Amazon CloudFront distribution. For more information about canonical
142 user IDs, see Access Control List (ACL) Overview in the Amazon Simple
143 Storage Service Developer Guide. For more information about using
144 CloudFront origin access identities to require that users use
145 CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access
146 Identity to Restrict Access to Your Amazon S3 Content.
147  
148 A canonical user ID is not the same as an AWS account number.
149  
150 =item *
151  
152 B<Email>: The value in the C<Grantee> object is the registered email
153 address of an AWS account.
154  
155 =item *
156  
157 B<Group>: The value in the C<Grantee> object is one of the following
158 predefined Amazon S3 groups: C<AllUsers>, C<AuthenticatedUsers>, or
159 C<LogDelivery>.
160  
161 =back
162  
163 =item *
164  
165 B<Grantee>: The AWS user or group that you want to have access to
166 transcoded files and playlists. To identify the user or group, you can
167 specify the canonical user ID for an AWS account, an origin access
168 identity for a CloudFront distribution, the registered email address of
169 an AWS account, or a predefined Amazon S3 group
170  
171 =item *
172  
173 B<Access>: The permission that you want to give to the AWS user that
174 you specified in C<Grantee>. Permissions are granted on the files that
175 Elastic Transcoder adds to the bucket, including playlists and video
176 files. Valid values include:
177  
178 =over
179  
180 =item *
181  
182 C<READ>: The grantee can read the objects and metadata for objects that
183 Elastic Transcoder adds to the Amazon S3 bucket.
184  
185 =item *
186  
187 C<READ_ACP>: The grantee can read the object ACL for objects that
188 Elastic Transcoder adds to the Amazon S3 bucket.
189  
190 =item *
191  
192 C<WRITE_ACP>: The grantee can write the ACL for the objects that
193 Elastic Transcoder adds to the Amazon S3 bucket.
194  
195 =item *
196  
197 C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP>
198 permissions for the objects that Elastic Transcoder adds to the Amazon
199 S3 bucket.
200  
201 =back
202  
203 =item *
204  
205 B<StorageClass>: The Amazon S3 storage class, C<Standard> or
206 C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the
207 video files and playlists that it stores in your Amazon S3 bucket.
208  
209 =back
210  
211  
212  
213  
214 =head2 B<REQUIRED> InputBucket => Str
215  
216 The Amazon S3 bucket in which you saved the media files that you want
217 to transcode.
218  
219  
220  
221 =head2 B<REQUIRED> Name => Str
222  
223 The name of the pipeline. We recommend that the name be unique within
224 the AWS account, but uniqueness is not enforced.
225  
226 Constraints: Maximum 40 characters.
227  
228  
229  
230 =head2 Notifications => L<Paws::ElasticTranscoder::Notifications>
231  
232 The Amazon Simple Notification Service (Amazon SNS) topic that you want
233 to notify to report job status.
234  
235 To receive notifications, you must also subscribe to the new topic in
236 the Amazon SNS console.
237  
238 =over
239  
240 =item *
241  
242 B<Progressing>: The topic ARN for the Amazon Simple Notification
243 Service (Amazon SNS) topic that you want to notify when Elastic
244 Transcoder has started to process a job in this pipeline. This is the
245 ARN that Amazon SNS returned when you created the topic. For more
246 information, see Create a Topic in the Amazon Simple Notification
247 Service Developer Guide.
248  
249 =item *
250  
251 B<Complete>: The topic ARN for the Amazon SNS topic that you want to
252 notify when Elastic Transcoder has finished processing a job in this
253 pipeline. This is the ARN that Amazon SNS returned when you created the
254 topic.
255  
256 =item *
257  
258 B<Warning>: The topic ARN for the Amazon SNS topic that you want to
259 notify when Elastic Transcoder encounters a warning condition while
260 processing a job in this pipeline. This is the ARN that Amazon SNS
261 returned when you created the topic.
262  
263 =item *
264  
265 B<Error>: The topic ARN for the Amazon SNS topic that you want to
266 notify when Elastic Transcoder encounters an error condition while
267 processing a job in this pipeline. This is the ARN that Amazon SNS
268 returned when you created the topic.
269  
270 =back
271  
272  
273  
274  
275 =head2 OutputBucket => Str
276  
277 The Amazon S3 bucket in which you want Elastic Transcoder to save the
278 transcoded files. (Use this, or use ContentConfig:Bucket plus
279 ThumbnailConfig:Bucket.)
280  
281 Specify this value when all of the following are true:
282  
283 =over
284  
285 =item *
286  
287 You want to save transcoded files, thumbnails (if any), and playlists
288 (if any) together in one bucket.
289  
290 =item *
291  
292 You do not want to specify the users or groups who have access to the
293 transcoded files, thumbnails, and playlists.
294  
295 =item *
296  
297 You do not want to specify the permissions that Elastic Transcoder
298 grants to the files.
299  
300 When Elastic Transcoder saves files in C<OutputBucket>, it grants full
301 control over the files only to the AWS account that owns the role that
302 is specified by C<Role>.
303  
304 =item *
305  
306 You want to associate the transcoded files and thumbnails with the
307 Amazon S3 Standard storage class.
308  
309 =back
310  
311 If you want to save transcoded files and playlists in one bucket and
312 thumbnails in another bucket, specify which users can access the
313 transcoded files or the permissions the users have, or change the
314 Amazon S3 storage class, omit C<OutputBucket> and specify values for
315 C<ContentConfig> and C<ThumbnailConfig> instead.
316  
317  
318  
319 =head2 B<REQUIRED> Role => Str
320  
321 The IAM Amazon Resource Name (ARN) for the role that you want Elastic
322 Transcoder to use to create the pipeline.
323  
324  
325  
326 =head2 ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>
327  
328 The C<ThumbnailConfig> object specifies several values, including the
329 Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail
330 files, which users you want to have access to the files, the type of
331 access you want users to have, and the storage class that you want to
332 assign to the files.
333  
334 If you specify values for C<ContentConfig>, you must also specify
335 values for C<ThumbnailConfig> even if you don't want to create
336 thumbnails.
337  
338 If you specify values for C<ContentConfig> and C<ThumbnailConfig>, omit
339 the C<OutputBucket> object.
340  
341 =over
342  
343 =item *
344  
345 B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to
346 save thumbnail files.
347  
348 =item *
349  
350 B<Permissions> (Optional): The C<Permissions> object specifies which
351 users and/or predefined Amazon S3 groups you want to have access to
352 thumbnail files, and the type of access you want them to have. You can
353 grant permissions to a maximum of 30 users and/or predefined Amazon S3
354 groups.
355  
356 =item *
357  
358 B<GranteeType>: Specify the type of value that appears in the Grantee
359 object:
360  
361 =over
362  
363 =item *
364  
365 B<Canonical>: The value in the C<Grantee> object is either the
366 canonical user ID for an AWS account or an origin access identity for
367 an Amazon CloudFront distribution.
368  
369 A canonical user ID is not the same as an AWS account number.
370  
371 =item *
372  
373 B<Email>: The value in the C<Grantee> object is the registered email
374 address of an AWS account.
375  
376 =item *
377  
378 B<Group>: The value in the C<Grantee> object is one of the following
379 predefined Amazon S3 groups: C<AllUsers>, C<AuthenticatedUsers>, or
380 C<LogDelivery>.
381  
382 =back
383  
384 =item *
385  
386 B<Grantee>: The AWS user or group that you want to have access to
387 thumbnail files. To identify the user or group, you can specify the
388 canonical user ID for an AWS account, an origin access identity for a
389 CloudFront distribution, the registered email address of an AWS
390 account, or a predefined Amazon S3 group.
391  
392 =item *
393  
394 B<Access>: The permission that you want to give to the AWS user that
395 you specified in C<Grantee>. Permissions are granted on the thumbnail
396 files that Elastic Transcoder adds to the bucket. Valid values include:
397  
398 =over
399  
400 =item *
401  
402 C<READ>: The grantee can read the thumbnails and metadata for objects
403 that Elastic Transcoder adds to the Amazon S3 bucket.
404  
405 =item *
406  
407 C<READ_ACP>: The grantee can read the object ACL for thumbnails that
408 Elastic Transcoder adds to the Amazon S3 bucket.
409  
410 =item *
411  
412 C<WRITE_ACP>: The grantee can write the ACL for the thumbnails that
413 Elastic Transcoder adds to the Amazon S3 bucket.
414  
415 =item *
416  
417 C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP>
418 permissions for the thumbnails that Elastic Transcoder adds to the
419 Amazon S3 bucket.
420  
421 =back
422  
423 =item *
424  
425 B<StorageClass>: The Amazon S3 storage class, C<Standard> or
426 C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the
427 thumbnails that it stores in your Amazon S3 bucket.
428  
429 =back
430  
431  
432  
433  
434  
435 =head1 SEE ALSO
436  
437 This class forms part of L<Paws>, documenting arguments for method CreatePipeline in L<Paws::ElasticTranscoder>
438  
439 =head1 BUGS and CONTRIBUTIONS
440  
441 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
442  
443 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
444  
445 =cut
446