File Coverage

blib/lib/Paws/ElasticTranscoder/UpdatePipeline.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ElasticTranscoder::UpdatePipeline;
3 1     1   394 use Moose;
  1         3  
  1         7  
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 1     1   6036 use MooseX::ClassAttribute;
  1         2  
  1         10  
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             class_has _result_key => (isa => 'Str', is => 'ro');
20             1;
21              
22             ### main pod documentation begin ###
23              
24             =head1 NAME
25              
26             Paws::ElasticTranscoder::UpdatePipeline - Arguments for method UpdatePipeline on Paws::ElasticTranscoder
27              
28             =head1 DESCRIPTION
29              
30             This class represents the parameters used for calling the method UpdatePipeline on the
31             Amazon Elastic Transcoder service. Use the attributes of this class
32             as arguments to method UpdatePipeline.
33              
34             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdatePipeline.
35              
36             As an example:
37              
38             $service_obj->UpdatePipeline(Att1 => $value1, Att2 => $value2, ...);
39              
40             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.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 AwsKmsKeyArn => Str
46              
47             The AWS Key Management Service (AWS KMS) key that you want to use with
48             this pipeline.
49              
50             If you use either C<S3> or C<S3-AWS-KMS> as your C<Encryption:Mode>,
51             you don't need to provide a key with your job because a default key,
52             known as an AWS-KMS key, is created for you automatically. You need to
53             provide an AWS-KMS key only if you want to use a non-default AWS-KMS
54             key, or if you are using an C<Encryption:Mode> of C<AES-PKCS7>,
55             C<AES-CTR>, or C<AES-GCM>.
56              
57              
58              
59             =head2 ContentConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>
60              
61             The optional C<ContentConfig> object specifies information about the
62             Amazon S3 bucket in which you want Elastic Transcoder to save
63             transcoded files and playlists: which bucket to use, which users you
64             want to have access to the files, the type of access you want users to
65             have, and the storage class that you want to assign to the files.
66              
67             If you specify values for C<ContentConfig>, you must also specify
68             values for C<ThumbnailConfig>.
69              
70             If you specify values for C<ContentConfig> and C<ThumbnailConfig>, omit
71             the C<OutputBucket> object.
72              
73             =over
74              
75             =item *
76              
77             B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to
78             save transcoded files and playlists.
79              
80             =item *
81              
82             B<Permissions> (Optional): The Permissions object specifies which users
83             you want to have access to transcoded files and the type of access you
84             want them to have. You can grant permissions to a maximum of 30 users
85             and/or predefined Amazon S3 groups.
86              
87             =item *
88              
89             B<Grantee Type>: Specify the type of value that appears in the
90             C<Grantee> object:
91              
92             =over
93              
94             =item *
95              
96             B<Canonical>: The value in the C<Grantee> object is either the
97             canonical user ID for an AWS account or an origin access identity for
98             an Amazon CloudFront distribution. For more information about canonical
99             user IDs, see Access Control List (ACL) Overview in the Amazon Simple
100             Storage Service Developer Guide. For more information about using
101             CloudFront origin access identities to require that users use
102             CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access
103             Identity to Restrict Access to Your Amazon S3 Content.
104              
105             A canonical user ID is not the same as an AWS account number.
106              
107             =item *
108              
109             B<Email>: The value in the C<Grantee> object is the registered email
110             address of an AWS account.
111              
112             =item *
113              
114             B<Group>: The value in the C<Grantee> object is one of the following
115             predefined Amazon S3 groups: C<AllUsers>, C<AuthenticatedUsers>, or
116             C<LogDelivery>.
117              
118             =back
119              
120             =item *
121              
122             B<Grantee>: The AWS user or group that you want to have access to
123             transcoded files and playlists. To identify the user or group, you can
124             specify the canonical user ID for an AWS account, an origin access
125             identity for a CloudFront distribution, the registered email address of
126             an AWS account, or a predefined Amazon S3 group
127              
128             =item *
129              
130             B<Access>: The permission that you want to give to the AWS user that
131             you specified in C<Grantee>. Permissions are granted on the files that
132             Elastic Transcoder adds to the bucket, including playlists and video
133             files. Valid values include:
134              
135             =over
136              
137             =item *
138              
139             C<READ>: The grantee can read the objects and metadata for objects that
140             Elastic Transcoder adds to the Amazon S3 bucket.
141              
142             =item *
143              
144             C<READ_ACP>: The grantee can read the object ACL for objects that
145             Elastic Transcoder adds to the Amazon S3 bucket.
146              
147             =item *
148              
149             C<WRITE_ACP>: The grantee can write the ACL for the objects that
150             Elastic Transcoder adds to the Amazon S3 bucket.
151              
152             =item *
153              
154             C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP>
155             permissions for the objects that Elastic Transcoder adds to the Amazon
156             S3 bucket.
157              
158             =back
159              
160             =item *
161              
162             B<StorageClass>: The Amazon S3 storage class, C<Standard> or
163             C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the
164             video files and playlists that it stores in your Amazon S3 bucket.
165              
166             =back
167              
168              
169              
170              
171             =head2 B<REQUIRED> Id => Str
172              
173             The ID of the pipeline that you want to update.
174              
175              
176              
177             =head2 InputBucket => Str
178              
179             The Amazon S3 bucket in which you saved the media files that you want
180             to transcode and the graphics that you want to use as watermarks.
181              
182              
183              
184             =head2 Name => Str
185              
186             The name of the pipeline. We recommend that the name be unique within
187             the AWS account, but uniqueness is not enforced.
188              
189             Constraints: Maximum 40 characters
190              
191              
192              
193             =head2 Notifications => L<Paws::ElasticTranscoder::Notifications>
194              
195             The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
196             topic that you want to notify to report job status.
197              
198             To receive notifications, you must also subscribe to the new topic in
199             the Amazon SNS console.
200              
201             =over
202              
203             =item *
204              
205             B<Progressing>: The topic ARN for the Amazon Simple Notification
206             Service (Amazon SNS) topic that you want to notify when Elastic
207             Transcoder has started to process jobs that are added to this pipeline.
208             This is the ARN that Amazon SNS returned when you created the topic.
209              
210             =item *
211              
212             B<Completed>: The topic ARN for the Amazon SNS topic that you want to
213             notify when Elastic Transcoder has finished processing a job. This is
214             the ARN that Amazon SNS returned when you created the topic.
215              
216             =item *
217              
218             B<Warning>: The topic ARN for the Amazon SNS topic that you want to
219             notify when Elastic Transcoder encounters a warning condition. This is
220             the ARN that Amazon SNS returned when you created the topic.
221              
222             =item *
223              
224             B<Error>: The topic ARN for the Amazon SNS topic that you want to
225             notify when Elastic Transcoder encounters an error condition. This is
226             the ARN that Amazon SNS returned when you created the topic.
227              
228             =back
229              
230              
231              
232              
233             =head2 Role => Str
234              
235             The IAM Amazon Resource Name (ARN) for the role that you want Elastic
236             Transcoder to use to transcode jobs for this pipeline.
237              
238              
239              
240             =head2 ThumbnailConfig => L<Paws::ElasticTranscoder::PipelineOutputConfig>
241              
242             The C<ThumbnailConfig> object specifies several values, including the
243             Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail
244             files, which users you want to have access to the files, the type of
245             access you want users to have, and the storage class that you want to
246             assign to the files.
247              
248             If you specify values for C<ContentConfig>, you must also specify
249             values for C<ThumbnailConfig> even if you don't want to create
250             thumbnails.
251              
252             If you specify values for C<ContentConfig> and C<ThumbnailConfig>, omit
253             the C<OutputBucket> object.
254              
255             =over
256              
257             =item *
258              
259             B<Bucket>: The Amazon S3 bucket in which you want Elastic Transcoder to
260             save thumbnail files.
261              
262             =item *
263              
264             B<Permissions> (Optional): The C<Permissions> object specifies which
265             users and/or predefined Amazon S3 groups you want to have access to
266             thumbnail files, and the type of access you want them to have. You can
267             grant permissions to a maximum of 30 users and/or predefined Amazon S3
268             groups.
269              
270             =item *
271              
272             B<GranteeType>: Specify the type of value that appears in the Grantee
273             object:
274              
275             =over
276              
277             =item *
278              
279             B<Canonical>: The value in the C<Grantee> object is either the
280             canonical user ID for an AWS account or an origin access identity for
281             an Amazon CloudFront distribution.
282              
283             A canonical user ID is not the same as an AWS account number.
284              
285             =item *
286              
287             B<Email>: The value in the C<Grantee> object is the registered email
288             address of an AWS account.
289              
290             =item *
291              
292             B<Group>: The value in the C<Grantee> object is one of the following
293             predefined Amazon S3 groups: C<AllUsers>, C<AuthenticatedUsers>, or
294             C<LogDelivery>.
295              
296             =back
297              
298             =item *
299              
300             B<Grantee>: The AWS user or group that you want to have access to
301             thumbnail files. To identify the user or group, you can specify the
302             canonical user ID for an AWS account, an origin access identity for a
303             CloudFront distribution, the registered email address of an AWS
304             account, or a predefined Amazon S3 group.
305              
306             =item *
307              
308             B<Access>: The permission that you want to give to the AWS user that
309             you specified in C<Grantee>. Permissions are granted on the thumbnail
310             files that Elastic Transcoder adds to the bucket. Valid values include:
311              
312             =over
313              
314             =item *
315              
316             C<READ>: The grantee can read the thumbnails and metadata for objects
317             that Elastic Transcoder adds to the Amazon S3 bucket.
318              
319             =item *
320              
321             C<READ_ACP>: The grantee can read the object ACL for thumbnails that
322             Elastic Transcoder adds to the Amazon S3 bucket.
323              
324             =item *
325              
326             C<WRITE_ACP>: The grantee can write the ACL for the thumbnails that
327             Elastic Transcoder adds to the Amazon S3 bucket.
328              
329             =item *
330              
331             C<FULL_CONTROL>: The grantee has C<READ>, C<READ_ACP>, and C<WRITE_ACP>
332             permissions for the thumbnails that Elastic Transcoder adds to the
333             Amazon S3 bucket.
334              
335             =back
336              
337             =item *
338              
339             B<StorageClass>: The Amazon S3 storage class, C<Standard> or
340             C<ReducedRedundancy>, that you want Elastic Transcoder to assign to the
341             thumbnails that it stores in your Amazon S3 bucket.
342              
343             =back
344              
345              
346              
347              
348              
349             =head1 SEE ALSO
350              
351             This class forms part of L<Paws>, documenting arguments for method UpdatePipeline in L<Paws::ElasticTranscoder>
352              
353             =head1 BUGS and CONTRIBUTIONS
354              
355             The source code is located here: https://github.com/pplu/aws-sdk-perl
356              
357             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
358              
359             =cut
360