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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ElasticTranscoder::UpdatePipeline;
3 use Moose;
4 has AwsKmsKeyArn => (is => 'ro', isa => 'Str');
5 has ContentConfig => (is => 'ro', isa => 'Paws::ElasticTranscoder::PipelineOutputConfig');
6 has Id => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Id', required => 1);
7 has InputBucket => (is => 'ro', isa => 'Str');
8 has Name => (is => 'ro', isa => 'Str');
9 has Notifications => (is => 'ro', isa => 'Paws::ElasticTranscoder::Notifications');
10 has Role => (is => 'ro', isa => 'Str');
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 => 'UpdatePipeline');
16 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2012-09-25/pipelines/{Id}');
17 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
18 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticTranscoder::UpdatePipelineResponse');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::ElasticTranscoder::UpdatePipeline - Arguments for method UpdatePipeline on L<Paws::ElasticTranscoder>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method UpdatePipeline on the
30 L<Amazon Elastic Transcoder|Paws::ElasticTranscoder> service. Use the attributes of this class
31 as arguments to method UpdatePipeline.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdatePipeline.
34  
35 =head1 SYNOPSIS
36  
37 my $elastictranscoder = Paws->service('ElasticTranscoder');
38 my $UpdatePipelineResponse = $elastictranscoder->UpdatePipeline(
39 Id => 'MyId',
40 AwsKmsKeyArn => 'MyKeyArn', # OPTIONAL
41 ContentConfig => {
42 Bucket => 'MyBucketName', # OPTIONAL
43 Permissions => [
44 {
45 Access => [ 'MyAccessControl', ... ], # max: 30; OPTIONAL
46 Grantee => 'MyGrantee', # min: 1, max: 255; OPTIONAL
47 GranteeType => 'MyGranteeType', # OPTIONAL
48 },
49 ...
50 ], # max: 30; OPTIONAL
51 StorageClass => 'MyStorageClass', # OPTIONAL
52 }, # OPTIONAL
53 InputBucket => 'MyBucketName', # OPTIONAL
54 Name => 'MyName', # OPTIONAL
55 Notifications => {
56 Completed => 'MySnsTopic', # OPTIONAL
57 Error => 'MySnsTopic', # OPTIONAL
58 Progressing => 'MySnsTopic', # OPTIONAL
59 Warning => 'MySnsTopic', # OPTIONAL
60 }, # OPTIONAL
61 Role => 'MyRole', # OPTIONAL
62 ThumbnailConfig => {
63 Bucket => 'MyBucketName', # OPTIONAL
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 = $UpdatePipelineResponse->Pipeline;
78 my $Warnings = $UpdatePipelineResponse->Warnings;
79  
80 # Returns a L<Paws::ElasticTranscoder::UpdatePipelineResponse> 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/UpdatePipeline>
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> Id => Str
215  
216 The ID of the pipeline that you want to update.
217  
218  
219  
220 =head2 InputBucket => Str
221  
222 The Amazon S3 bucket in which you saved the media files that you want
223 to transcode and the graphics that you want to use as watermarks.
224  
225  
226  
227 =head2 Name => Str
228  
229 The name of the pipeline. We recommend that the name be unique within
230 the AWS account, but uniqueness is not enforced.
231  
232 Constraints: Maximum 40 characters
233  
234  
235  
236 =head2 Notifications => L<Paws::ElasticTranscoder::Notifications>
237  
238 The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
239 topic that you want to notify to report job status.
240  
241 To receive notifications, you must also subscribe to the new topic in
242 the Amazon SNS console.
243  
244 =over
245  
246 =item *
247  
248 B<Progressing>: The topic ARN for the Amazon Simple Notification
249 Service (Amazon SNS) topic that you want to notify when Elastic
250 Transcoder has started to process jobs that are added to this pipeline.
251 This is the ARN that Amazon SNS returned when you created the topic.
252  
253 =item *
254  
255 B<Complete>: The topic ARN for the Amazon SNS topic that you want to
256 notify when Elastic Transcoder has finished processing a job. This is
257 the ARN that Amazon SNS returned when you created the topic.
258  
259 =item *
260  
261 B<Warning>: The topic ARN for the Amazon SNS topic that you want to
262 notify when Elastic Transcoder encounters a warning condition. This is
263 the ARN that Amazon SNS returned when you created the topic.
264  
265 =item *
266  
267 B<Error>: The topic ARN for the Amazon SNS topic that you want to
268 notify when Elastic Transcoder encounters an error condition. This is
269 the ARN that Amazon SNS returned when you created the topic.
270  
271 =back
272  
273  
274  
275  
276 =head2 Role => Str
277  
278 The IAM Amazon Resource Name (ARN) for the role that you want Elastic
279 Transcoder to use to transcode jobs for this pipeline.
280  
281  
282  
283 =head2 ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>
284  
285 The C<ThumbnailConfig> object specifies several values, including the
286 Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail
287 files, which users you want to have access to the files, the type of
288 access you want users to have, and the storage class that you want to
289 assign to the files.
290  
291 If you specify values for C<ContentConfig>, you must also specify
292 values for C<ThumbnailConfig> even if you don't want to create
293 thumbnails.
294  
295 If you specify values for C<ContentConfig> and C<ThumbnailConfig>, omit
296 the C<OutputBucket> object.
297  
298 =over
299  
300 =item *
301  
302 B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to
303 save thumbnail files.
304  
305 =item *
306  
307 B<Permissions> (Optional): The C<Permissions> object specifies which
308 users and/or predefined Amazon S3 groups you want to have access to
309 thumbnail files, and the type of access you want them to have. You can
310 grant permissions to a maximum of 30 users and/or predefined Amazon S3
311 groups.
312  
313 =item *
314  
315 B<GranteeType>: Specify the type of value that appears in the Grantee
316 object:
317  
318 =over
319  
320 =item *
321  
322 B<Canonical>: The value in the C<Grantee> object is either the
323 canonical user ID for an AWS account or an origin access identity for
324 an Amazon CloudFront distribution.
325  
326 A canonical user ID is not the same as an AWS account number.
327  
328 =item *
329  
330 B<Email>: The value in the C<Grantee> object is the registered email
331 address of an AWS account.
332  
333 =item *
334  
335 B<Group>: The value in the C<Grantee> object is one of the following
336 predefined Amazon S3 groups: C<AllUsers>, C<AuthenticatedUsers>, or
337 C<LogDelivery>.
338  
339 =back
340  
341 =item *
342  
343 B<Grantee>: The AWS user or group that you want to have access to
344 thumbnail files. To identify the user or group, you can specify the
345 canonical user ID for an AWS account, an origin access identity for a
346 CloudFront distribution, the registered email address of an AWS
347 account, or a predefined Amazon S3 group.
348  
349 =item *
350  
351 B<Access>: The permission that you want to give to the AWS user that
352 you specified in C<Grantee>. Permissions are granted on the thumbnail
353 files that Elastic Transcoder adds to the bucket. Valid values include:
354  
355 =over
356  
357 =item *
358  
359 C<READ>: The grantee can read the thumbnails and metadata for objects
360 that Elastic Transcoder adds to the Amazon S3 bucket.
361  
362 =item *
363  
364 C<READ_ACP>: The grantee can read the object ACL for thumbnails that
365 Elastic Transcoder adds to the Amazon S3 bucket.
366  
367 =item *
368  
369 C<WRITE_ACP>: The grantee can write the ACL for the thumbnails that
370 Elastic Transcoder adds to the Amazon S3 bucket.
371  
372 =item *
373  
374 C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP>
375 permissions for the thumbnails that Elastic Transcoder adds to the
376 Amazon S3 bucket.
377  
378 =back
379  
380 =item *
381  
382 B<StorageClass>: The Amazon S3 storage class, C<Standard> or
383 C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the
384 thumbnails that it stores in your Amazon S3 bucket.
385  
386 =back
387  
388  
389  
390  
391  
392 =head1 SEE ALSO
393  
394 This class forms part of L<Paws>, documenting arguments for method UpdatePipeline in L<Paws::ElasticTranscoder>
395  
396 =head1 BUGS and CONTRIBUTIONS
397  
398 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
399  
400 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
401  
402 =cut
403