aws-sdk 1.13.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -3
  3. data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
  4. data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
  5. data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
  6. data/lib/aws/auto_scaling/client.rb +0 -530
  7. data/lib/aws/cloud_formation/client.rb +0 -356
  8. data/lib/aws/cloud_front/client.rb +0 -1567
  9. data/lib/aws/cloud_search/client.rb +0 -578
  10. data/lib/aws/cloud_watch/client.rb +0 -445
  11. data/lib/aws/data_pipeline/client.rb +0 -396
  12. data/lib/aws/direct_connect/client.rb +0 -248
  13. data/lib/aws/dynamo_db.rb +0 -1
  14. data/lib/aws/dynamo_db/client.rb +70 -1
  15. data/lib/aws/dynamo_db/client_v2.rb +1 -1
  16. data/lib/aws/ec2/client.rb +0 -3942
  17. data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
  18. data/lib/aws/ec2/tag_collection.rb +1 -1
  19. data/lib/aws/elastic_beanstalk/client.rb +0 -898
  20. data/lib/aws/elastic_transcoder/client.rb +0 -1755
  21. data/lib/aws/elasticache/client.rb +0 -947
  22. data/lib/aws/elb/client.rb +0 -509
  23. data/lib/aws/emr/client.rb +0 -314
  24. data/lib/aws/glacier/client.rb +0 -278
  25. data/lib/aws/iam/client.rb +0 -1155
  26. data/lib/aws/import_export/client.rb +0 -96
  27. data/lib/aws/ops_works/client.rb +0 -1255
  28. data/lib/aws/rds/client.rb +0 -2367
  29. data/lib/aws/redshift/client.rb +0 -1458
  30. data/lib/aws/route_53/client.rb +0 -420
  31. data/lib/aws/simple_db/client.rb +2 -250
  32. data/lib/aws/simple_email_service/client.rb +0 -282
  33. data/lib/aws/simple_workflow/client.rb +0 -1248
  34. data/lib/aws/sns/client.rb +0 -283
  35. data/lib/aws/sns/message.rb +1 -1
  36. data/lib/aws/sqs/client.rb +0 -255
  37. data/lib/aws/storage_gateway/client.rb +0 -582
  38. data/lib/aws/sts/client.rb +0 -183
  39. data/lib/aws/support/client.rb +0 -232
  40. data/lib/aws/version.rb +1 -1
  41. metadata +2 -3
  42. data/lib/aws/dynamo_db/client_base.rb +0 -92
@@ -39,1761 +39,6 @@ module AWS
39
39
 
40
40
  class Client::V20120925 < Client
41
41
 
42
- # client methods #
43
-
44
- # @!method cancel_job(options = {})
45
- # Calls the DELETE CancelJob API operation.
46
- # @param [Hash] options
47
- #
48
- # * `:id` - *required* - (String) The identifier of the job that you
49
- # want to cancel. To get a list of the jobs (including their jobId)
50
- # that have a status of Submitted, use the ListJobsByStatus API
51
- # action.
52
- # @return [Core::Response]
53
-
54
- # @!method create_job(options = {})
55
- # Calls the POST CreateJob API operation.
56
- # @param [Hash] options
57
- #
58
- # * `:pipeline_id` - (String) The Id of the pipeline that you want
59
- # Elastic Transcoder to use for transcoding. The pipeline determines
60
- # several settings, including the Amazon S3 bucket from which Elastic
61
- # Transcoder gets the files to transcode and the bucket into which
62
- # Elastic Transcoder puts the transcoded files.
63
- # * `:input` - (Hash) A section of the request body that provides
64
- # information about the file that is being transcoded.
65
- # * `:key` - (String) The name of the file to transcode. Elsewhere in
66
- # the body of the JSON block is the the ID of the pipeline to use
67
- # for processing the job. The InputBucket object in that pipeline
68
- # tells Elastic Transcoder which Amazon S3 bucket to get the file
69
- # from. If the file name includes a prefix, such as
70
- # cooking/lasagna.mpg, include the prefix in the key. If the file
71
- # isn't in the specified bucket, Elastic Transcoder returns an
72
- # error.
73
- # * `:frame_rate` - (String) The frame rate of the input file. If you
74
- # want Elastic Transcoder to automatically detect the frame rate of
75
- # the input file, specify auto. If you want to specify the frame
76
- # rate for the input file, enter one of the following values: 10,
77
- # 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other
78
- # than auto, Elastic Transcoder disables automatic detection of the
79
- # frame rate.
80
- # * `:resolution` - (String) This value must be auto, which causes
81
- # Elastic Transcoder to automatically detect the resolution of the
82
- # input file.
83
- # * `:aspect_ratio` - (String) The aspect ratio of the input file. If
84
- # you want Elastic Transcoder to automatically detect the aspect
85
- # ratio of the input file, specify auto. If you want to specify the
86
- # aspect ratio for the output file, enter one of the following
87
- # values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than
88
- # auto, Elastic Transcoder disables automatic detection of the
89
- # aspect ratio.
90
- # * `:interlaced` - (String) Whether the input file is interlaced. If
91
- # you want Elastic Transcoder to automatically detect whether the
92
- # input file is interlaced, specify auto. If you want to specify
93
- # whether the input file is interlaced, enter one of the following
94
- # values: `true` , `false` If you specify a value other than auto,
95
- # Elastic Transcoder disables automatic detection of interlacing.
96
- # * `:container` - (String) The container type for the input file. If
97
- # you want Elastic Transcoder to automatically detect the container
98
- # type of the input file, specify auto. If you want to specify the
99
- # container type for the input file, enter one of the following
100
- # values: 3gp, asf, avi, divx, flv, mkv, mov, mp4, mpeg, mpeg-ps,
101
- # mpeg-ts, mxf, ogg, vob, wav, webm
102
- # * `:output` - (Hash)
103
- # * `:key` - (String) The name to assign to the transcoded file.
104
- # Elastic Transcoder saves the file in the Amazon S3 bucket
105
- # specified by the OutputBucket object in the pipeline that is
106
- # specified by the pipeline ID. If a file with the specified name
107
- # already exists in the output bucket, the job fails.
108
- # * `:thumbnail_pattern` - (String) Whether you want Elastic
109
- # Transcoder to create thumbnails for your videos and, if so, how
110
- # you want Elastic Transcoder to name the files. If you don't want
111
- # Elastic Transcoder to create thumbnails, specify "". If you do
112
- # want Elastic Transcoder to create thumbnails, specify the
113
- # information that you want to include in the file name for each
114
- # thumbnail. You can specify the following values in any sequence:
115
- # {count} (Required): If you want to create thumbnails, you must
116
- # include {count} in the ThumbnailPattern object. Wherever you
117
- # specify {count}, Elastic Transcoder adds a five-digit sequence
118
- # number (beginning with 00001) to thumbnail file names. The number
119
- # indicates where a given thumbnail appears in the sequence of
120
- # thumbnails for a transcoded file. If you specify a literal value
121
- # and/or {resolution} but you omit {count}, Elastic Transcoder
122
- # returns a validation error and does not create the job. Literal
123
- # values (Optional): You can specify literal values anywhere in the
124
- # ThumbnailPattern object. For example, you can include them as a
125
- # file name prefix or as a delimiter between {resolution} and
126
- # {count}. {resolution} (Optional): If you want Elastic Transcoder
127
- # to include the resolution in the file name, include {resolution}
128
- # in the ThumbnailPattern object. When creating thumbnails, Elastic
129
- # Transcoder automatically saves the files in the format (.jpg or
130
- # .png) that appears in the preset that you specified in the
131
- # PresetID value of CreateJobOutput. Elastic Transcoder also
132
- # appends the applicable file name extension.
133
- # * `:rotate` - (String) The number of degrees clockwise by which you
134
- # want Elastic Transcoder to rotate the output relative to the
135
- # input. Enter one of the following values: auto, 0, 90, 180, 270.
136
- # The value auto generally works only if the file that you're
137
- # transcoding contains rotation metadata.
138
- # * `:preset_id` - (String) The Id of the preset to use for this job.
139
- # The preset determines the audio, video, and thumbnail settings
140
- # that Elastic Transcoder uses for transcoding.
141
- # * `:segment_duration` - (String) If you specify a preset in
142
- # PresetId for which the value of Container is ts (MPEG-TS),
143
- # SegmentDuration is the duration of each .ts file in seconds. The
144
- # range of valid values is 1 to 60 seconds.
145
- # * `:watermarks` - (Array<Hash>) Information about the watermarks
146
- # that you want Elastic Transcoder to add to the video during
147
- # transcoding. You can specify up to four watermarks for each
148
- # output. Settings for each watermark must be defined in the preset
149
- # for the current output.
150
- # * `:preset_watermark_id` - (String) The ID of the watermark
151
- # settings that Elastic Transcoder uses to add watermarks to the
152
- # video during transcoding. The settings are in the preset
153
- # specified by Preset for the current output. In that preset, the
154
- # value of Watermarks Id tells Elastic Transcoder which settings
155
- # to use.
156
- # * `:input_key` - (String) The name of the .png or .jpg file that
157
- # you want to use for the watermark. To determine which Amazon S3
158
- # bucket contains the specified file, Elastic Transcoder checks
159
- # the pipeline specified by Pipeline; the Input Bucket object in
160
- # that pipeline identifies the bucket. If the file name includes
161
- # a prefix, for example, logos/128x64.png, include the prefix in
162
- # the key. If the file isn't in the specified bucket, Elastic
163
- # Transcoder returns an error.
164
- # * `:outputs` - (Array<Hash>) A section of the request body that
165
- # provides information about the transcoded (target) files. We
166
- # recommend that you use the Outputs syntax instead of the Output
167
- # syntax.
168
- # * `:key` - (String) The name to assign to the transcoded file.
169
- # Elastic Transcoder saves the file in the Amazon S3 bucket
170
- # specified by the OutputBucket object in the pipeline that is
171
- # specified by the pipeline ID. If a file with the specified name
172
- # already exists in the output bucket, the job fails.
173
- # * `:thumbnail_pattern` - (String) Whether you want Elastic
174
- # Transcoder to create thumbnails for your videos and, if so, how
175
- # you want Elastic Transcoder to name the files. If you don't want
176
- # Elastic Transcoder to create thumbnails, specify "". If you do
177
- # want Elastic Transcoder to create thumbnails, specify the
178
- # information that you want to include in the file name for each
179
- # thumbnail. You can specify the following values in any sequence:
180
- # {count} (Required): If you want to create thumbnails, you must
181
- # include {count} in the ThumbnailPattern object. Wherever you
182
- # specify {count}, Elastic Transcoder adds a five-digit sequence
183
- # number (beginning with 00001) to thumbnail file names. The number
184
- # indicates where a given thumbnail appears in the sequence of
185
- # thumbnails for a transcoded file. If you specify a literal value
186
- # and/or {resolution} but you omit {count}, Elastic Transcoder
187
- # returns a validation error and does not create the job. Literal
188
- # values (Optional): You can specify literal values anywhere in the
189
- # ThumbnailPattern object. For example, you can include them as a
190
- # file name prefix or as a delimiter between {resolution} and
191
- # {count}. {resolution} (Optional): If you want Elastic Transcoder
192
- # to include the resolution in the file name, include {resolution}
193
- # in the ThumbnailPattern object. When creating thumbnails, Elastic
194
- # Transcoder automatically saves the files in the format (.jpg or
195
- # .png) that appears in the preset that you specified in the
196
- # PresetID value of CreateJobOutput. Elastic Transcoder also
197
- # appends the applicable file name extension.
198
- # * `:rotate` - (String) The number of degrees clockwise by which you
199
- # want Elastic Transcoder to rotate the output relative to the
200
- # input. Enter one of the following values: auto, 0, 90, 180, 270.
201
- # The value auto generally works only if the file that you're
202
- # transcoding contains rotation metadata.
203
- # * `:preset_id` - (String) The Id of the preset to use for this job.
204
- # The preset determines the audio, video, and thumbnail settings
205
- # that Elastic Transcoder uses for transcoding.
206
- # * `:segment_duration` - (String) If you specify a preset in
207
- # PresetId for which the value of Container is ts (MPEG-TS),
208
- # SegmentDuration is the duration of each .ts file in seconds. The
209
- # range of valid values is 1 to 60 seconds.
210
- # * `:watermarks` - (Array<Hash>) Information about the watermarks
211
- # that you want Elastic Transcoder to add to the video during
212
- # transcoding. You can specify up to four watermarks for each
213
- # output. Settings for each watermark must be defined in the preset
214
- # for the current output.
215
- # * `:preset_watermark_id` - (String) The ID of the watermark
216
- # settings that Elastic Transcoder uses to add watermarks to the
217
- # video during transcoding. The settings are in the preset
218
- # specified by Preset for the current output. In that preset, the
219
- # value of Watermarks Id tells Elastic Transcoder which settings
220
- # to use.
221
- # * `:input_key` - (String) The name of the .png or .jpg file that
222
- # you want to use for the watermark. To determine which Amazon S3
223
- # bucket contains the specified file, Elastic Transcoder checks
224
- # the pipeline specified by Pipeline; the Input Bucket object in
225
- # that pipeline identifies the bucket. If the file name includes
226
- # a prefix, for example, logos/128x64.png, include the prefix in
227
- # the key. If the file isn't in the specified bucket, Elastic
228
- # Transcoder returns an error.
229
- # * `:output_key_prefix` - (String) The value, if any, that you want
230
- # Elastic Transcoder to prepend to the names of all files that this
231
- # job creates, including output files, thumbnails, and playlists.
232
- # * `:playlists` - (Array<Hash>) If you specify a preset in PresetId
233
- # for which the value of Container is ts (MPEG-TS), Playlists
234
- # contains information about the master playlists that you want
235
- # Elastic Transcoder to create. We recommend that you create only one
236
- # master playlist. The maximum number of master playlists in a job is
237
- # 30.
238
- # * `:name` - (String) The name that you want Elastic Transcoder to
239
- # assign to the master playlist, for example, nyc-vacation.m3u8.
240
- # The name cannot include a / character. If you create more than
241
- # one master playlist (not recommended), the values of all Name
242
- # objects must be unique. Elastic Transcoder automatically appends
243
- # .m3u8 to the file name. If you include .m3u8 in Name, it will
244
- # appear twice in the file name.
245
- # * `:format` - (String) This value must currently be HLSv3.
246
- # * `:output_keys` - (Array<String>) For each output in this job that
247
- # you want to include in a master playlist, the value of the
248
- # Outputs:Key object. If you include more than one output in a
249
- # playlist, the value of SegmentDuration for all of the outputs
250
- # must be the same.
251
- # @return [Core::Response]
252
- # The #data method of the response object returns
253
- # a hash with the following structure:
254
- #
255
- # * `:job` - (Hash)
256
- # * `:id` - (String)
257
- # * `:pipeline_id` - (String)
258
- # * `:input` - (Hash)
259
- # * `:key` - (String)
260
- # * `:frame_rate` - (String)
261
- # * `:resolution` - (String)
262
- # * `:aspect_ratio` - (String)
263
- # * `:interlaced` - (String)
264
- # * `:container` - (String)
265
- # * `:output` - (Hash)
266
- # * `:id` - (String)
267
- # * `:key` - (String)
268
- # * `:thumbnail_pattern` - (String)
269
- # * `:rotate` - (String)
270
- # * `:preset_id` - (String)
271
- # * `:segment_duration` - (String)
272
- # * `:status` - (String)
273
- # * `:status_detail` - (String)
274
- # * `:duration` - (Integer)
275
- # * `:width` - (Integer)
276
- # * `:height` - (Integer)
277
- # * `:watermarks` - (Array<Hash>)
278
- # * `:preset_watermark_id` - (String)
279
- # * `:input_key` - (String)
280
- # * `:outputs` - (Array<Hash>)
281
- # * `:id` - (String)
282
- # * `:key` - (String)
283
- # * `:thumbnail_pattern` - (String)
284
- # * `:rotate` - (String)
285
- # * `:preset_id` - (String)
286
- # * `:segment_duration` - (String)
287
- # * `:status` - (String)
288
- # * `:status_detail` - (String)
289
- # * `:duration` - (Integer)
290
- # * `:width` - (Integer)
291
- # * `:height` - (Integer)
292
- # * `:watermarks` - (Array<Hash>)
293
- # * `:preset_watermark_id` - (String)
294
- # * `:input_key` - (String)
295
- # * `:output_key_prefix` - (String)
296
- # * `:playlists` - (Array<Hash>)
297
- # * `:name` - (String)
298
- # * `:format` - (String)
299
- # * `:output_keys` - (Array<String>)
300
- # * `:status` - (String)
301
- # * `:status_detail` - (String)
302
- # * `:status` - (String)
303
-
304
- # @!method create_pipeline(options = {})
305
- # Calls the POST CreatePipeline API operation.
306
- # @param [Hash] options
307
- #
308
- # * `:name` - (String) The name of the pipeline. We recommend that the
309
- # name be unique within the AWS account, but uniqueness is not
310
- # enforced. Constraints: Maximum 40 characters.
311
- # * `:input_bucket` - (String) The Amazon S3 bucket in which you saved
312
- # the media files that you want to transcode.
313
- # * `:output_bucket` - (String) The Amazon S3 bucket in which you want
314
- # Elastic Transcoder to save the transcoded files. (Use this, or use
315
- # ContentConfig:Bucket plus ThumbnailConfig:Bucket.) Specify this
316
- # value when all of the following are `true` : You want to save
317
- # transcoded files, thumbnails (if any), and playlists (if any)
318
- # together in one bucket. You do not want to specify the users or
319
- # groups who have access to the transcoded files, thumbnails, and
320
- # playlists. You do not want to specify the permissions that Elastic
321
- # Transcoder grants to the files. When Elastic Transcoder saves files
322
- # in OutputBucket, it grants full control over the files only to the
323
- # AWS account that owns the role that is specified by Role. You want
324
- # to associate the transcoded files and thumbnails with the Amazon S3
325
- # Standard storage class. If you want to save transcoded files and
326
- # playlists in one bucket and thumbnails in another bucket, specify
327
- # which users can access the transcoded files or the permissions the
328
- # users have, or change the Amazon S3 storage class, omit
329
- # OutputBucket and specify values for ContentConfig and
330
- # ThumbnailConfig instead.
331
- # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
332
- # that you want Elastic Transcoder to use to create the pipeline.
333
- # * `:notifications` - (Hash) The Amazon Simple Notification Service
334
- # (Amazon SNS) topic that you want to notify to report job status. To
335
- # receive notifications, you must also subscribe to the new topic in
336
- # the Amazon SNS console. Progressing: The topic ARN for the Amazon
337
- # Simple Notification Service (Amazon SNS) topic that you want to
338
- # notify when Elastic Transcoder has started to process a job in this
339
- # pipeline. This is the ARN that Amazon SNS returned when you created
340
- # the topic. For more information, see Create a Topic in the Amazon
341
- # Simple Notification Service Developer Guide. Completed: The topic
342
- # ARN for the Amazon SNS topic that you want to notify when Elastic
343
- # Transcoder has finished processing a job in this pipeline. This is
344
- # the ARN that Amazon SNS returned when you created the topic.
345
- # Warning: The topic ARN for the Amazon SNS topic that you want to
346
- # notify when Elastic Transcoder encounters a warning condition while
347
- # processing a job in this pipeline. This is the ARN that Amazon SNS
348
- # returned when you created the topic. Error: The topic ARN for the
349
- # Amazon SNS topic that you want to notify when Elastic Transcoder
350
- # encounters an error condition while processing a job in this
351
- # pipeline. This is the ARN that Amazon SNS returned when you created
352
- # the topic.
353
- # * `:progressing` - (String) The Amazon Simple Notification Service
354
- # (Amazon SNS) topic that you want to notify when Elastic
355
- # Transcoder has started to process the job.
356
- # * `:completed` - (String) The Amazon SNS topic that you want to
357
- # notify when Elastic Transcoder has finished processing the job.
358
- # * `:warning` - (String) The Amazon SNS topic that you want to
359
- # notify when Elastic Transcoder encounters a warning condition.
360
- # * `:error` - (String) The Amazon SNS topic that you want to notify
361
- # when Elastic Transcoder encounters an error condition.
362
- # * `:content_config` - (Hash) The optional ContentConfig object
363
- # specifies information about the Amazon S3 bucket in which you want
364
- # Elastic Transcoder to save transcoded files and playlists: which
365
- # bucket to use, which users you want to have access to the files,
366
- # the type of access you want users to have, and the storage class
367
- # that you want to assign to the files. If you specify values for
368
- # ContentConfig, you must also specify values for ThumbnailConfig. If
369
- # you specify values for ContentConfig and ThumbnailConfig, omit the
370
- # OutputBucket object. Bucket: The Amazon S3 bucket in which you want
371
- # Elastic Transcoder to save transcoded files and playlists.
372
- # Permissions (Optional): The Permissions object specifies which
373
- # users you want to have access to transcoded files and the type of
374
- # access you want them to have. You can grant permissions to a
375
- # maximum of 30 users and/or predefined Amazon S3 groups. Grantee
376
- # Type: Specify the type of value that appears in the Grantee object:
377
- # Canonical: The value in the Grantee object is either the canonical
378
- # user ID for an AWS account or an origin access identity for an
379
- # Amazon CloudFront distribution. For more information about
380
- # canonical user IDs, see Access Control List (ACL) Overview in the
381
- # Amazon Simple Storage Service Developer Guide. For more information
382
- # about using CloudFront origin access identities to require that
383
- # users use CloudFront URLs instead of Amazon S3 URLs, see Using an
384
- # Origin Access Identity to Restrict Access to Your Amazon S3
385
- # Content. A canonical user ID is not the same as an AWS account
386
- # number. Email: The value in the Grantee object is the registered
387
- # email address of an AWS account. Group: The value in the Grantee
388
- # object is one of the following predefined Amazon S3 groups:
389
- # AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user
390
- # or group that you want to have access to transcoded files and
391
- # playlists. To identify the user or group, you can specify the
392
- # canonical user ID for an AWS account, an origin access identity for
393
- # a CloudFront distribution, the registered email address of an AWS
394
- # account, or a predefined Amazon S3 group Access: The permission
395
- # that you want to give to the AWS user that you specified in
396
- # Grantee. Permissions are granted on the files that Elastic
397
- # Transcoder adds to the bucket, including playlists and video files.
398
- # Valid values include: READ: The grantee can read the objects and
399
- # metadata for objects that Elastic Transcoder adds to the Amazon S3
400
- # bucket. READ_ACP: The grantee can read the object ACL for objects
401
- # that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP:
402
- # The grantee can write the ACL for the objects that Elastic
403
- # Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee
404
- # has READ, READ_ACP, and WRITE_ACP permissions for the objects that
405
- # Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The
406
- # Amazon S3 storage class, Standard or ReducedRedundancy, that you
407
- # want Elastic Transcoder to assign to the video files and playlists
408
- # that it stores in your Amazon S3 bucket.
409
- # * `:bucket` - (String) The Amazon S3 bucket in which you want
410
- # Elastic Transcoder to save the transcoded files. Specify this
411
- # value when all of the following are `true` : You want to save
412
- # transcoded files, thumbnails (if any), and playlists (if any)
413
- # together in one bucket. You do not want to specify the users or
414
- # groups who have access to the transcoded files, thumbnails, and
415
- # playlists. You do not want to specify the permissions that
416
- # Elastic Transcoder grants to the files. You want to associate the
417
- # transcoded files and thumbnails with the Amazon S3 Standard
418
- # storage class. If you want to save transcoded files and playlists
419
- # in one bucket and thumbnails in another bucket, specify which
420
- # users can access the transcoded files or the permissions the
421
- # users have, or change the Amazon S3 storage class, omit
422
- # OutputBucket and specify values for ContentConfig and
423
- # ThumbnailConfig instead.
424
- # * `:storage_class` - (String) The Amazon S3 storage class, Standard
425
- # or ReducedRedundancy, that you want Elastic Transcoder to assign
426
- # to the video files and playlists that it stores in your Amazon S3
427
- # bucket.
428
- # * `:permissions` - (Array<Hash>) Optional. The Permissions object
429
- # specifies which users and/or predefined Amazon S3 groups you want
430
- # to have access to transcoded files and playlists, and the type of
431
- # access you want them to have. You can grant permissions to a
432
- # maximum of 30 users and/or predefined Amazon S3 groups. If you
433
- # include Permissions, Elastic Transcoder grants only the
434
- # permissions that you specify. It does not grant full permissions
435
- # to the owner of the role specified by Role. If you want that user
436
- # to have full control, you must explicitly grant full control to
437
- # the user. If you omit Permissions, Elastic Transcoder grants full
438
- # control over the transcoded files and playlists to the owner of
439
- # the role specified by Role, and grants no other permissions to
440
- # any other user or group.
441
- # * `:grantee_type` - (String) The type of value that appears in
442
- # the Grantee object: Canonical: Either the canonical user ID for
443
- # an AWS account or an origin access identity for an Amazon
444
- # CloudFront distribution. A canonical user ID is not the same as
445
- # an AWS account number. Email: The registered email address of
446
- # an AWS account. Group: One of the following predefined Amazon
447
- # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
448
- # * `:grantee` - (String) The AWS user or group that you want to
449
- # have access to transcoded files and playlists. To identify the
450
- # user or group, you can specify the canonical user ID for an AWS
451
- # account, an origin access identity for a CloudFront
452
- # distribution, the registered email address of an AWS account,
453
- # or a predefined Amazon S3 group.
454
- # * `:access` - (Array<String>) The permission that you want to
455
- # give to the AWS user that is listed in Grantee. Valid values
456
- # include: READ: The grantee can read the thumbnails and metadata
457
- # for thumbnails that Elastic Transcoder adds to the Amazon S3
458
- # bucket. READ_ACP: The grantee can read the object ACL for
459
- # thumbnails that Elastic Transcoder adds to the Amazon S3
460
- # bucket. WRITE_ACP: The grantee can write the ACL for the
461
- # thumbnails that Elastic Transcoder adds to the Amazon S3
462
- # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
463
- # WRITE_ACP permissions for the thumbnails that Elastic
464
- # Transcoder adds to the Amazon S3 bucket.
465
- # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
466
- # several values, including the Amazon S3 bucket in which you want
467
- # Elastic Transcoder to save thumbnail files, which users you want to
468
- # have access to the files, the type of access you want users to
469
- # have, and the storage class that you want to assign to the files.
470
- # If you specify values for ContentConfig, you must also specify
471
- # values for ThumbnailConfig even if you don't want to create
472
- # thumbnails. If you specify values for ContentConfig and
473
- # ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon
474
- # S3 bucket in which you want Elastic Transcoder to save thumbnail
475
- # files. Permissions (Optional): The Permissions object specifies
476
- # which users and/or predefined Amazon S3 groups you want to have
477
- # access to thumbnail files, and the type of access you want them to
478
- # have. You can grant permissions to a maximum of 30 users and/or
479
- # predefined Amazon S3 groups. GranteeType: Specify the type of value
480
- # that appears in the Grantee object: Canonical: The value in the
481
- # Grantee object is either the canonical user ID for an AWS account
482
- # or an origin access identity for an Amazon CloudFront distribution.
483
- # A canonical user ID is not the same as an AWS account number.
484
- # Email: The value in the Grantee object is the registered email
485
- # address of an AWS account. Group: The value in the Grantee object
486
- # is one of the following predefined Amazon S3 groups: AllUsers,
487
- # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
488
- # that you want to have access to thumbnail files. To identify the
489
- # user or group, you can specify the canonical user ID for an AWS
490
- # account, an origin access identity for a CloudFront distribution,
491
- # the registered email address of an AWS account, or a predefined
492
- # Amazon S3 group. Access: The permission that you want to give to
493
- # the AWS user that you specified in Grantee. Permissions are granted
494
- # on the thumbnail files that Elastic Transcoder adds to the bucket.
495
- # Valid values include: READ: The grantee can read the thumbnails and
496
- # metadata for objects that Elastic Transcoder adds to the Amazon S3
497
- # bucket. READ_ACP: The grantee can read the object ACL for
498
- # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
499
- # WRITE_ACP: The grantee can write the ACL for the thumbnails that
500
- # Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
501
- # grantee has READ, READ_ACP, and WRITE_ACP permissions for the
502
- # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
503
- # StorageClass: The Amazon S3 storage class, Standard or
504
- # ReducedRedundancy, that you want Elastic Transcoder to assign to
505
- # the thumbnails that it stores in your Amazon S3 bucket.
506
- # * `:bucket` - (String) The Amazon S3 bucket in which you want
507
- # Elastic Transcoder to save the transcoded files. Specify this
508
- # value when all of the following are `true` : You want to save
509
- # transcoded files, thumbnails (if any), and playlists (if any)
510
- # together in one bucket. You do not want to specify the users or
511
- # groups who have access to the transcoded files, thumbnails, and
512
- # playlists. You do not want to specify the permissions that
513
- # Elastic Transcoder grants to the files. You want to associate the
514
- # transcoded files and thumbnails with the Amazon S3 Standard
515
- # storage class. If you want to save transcoded files and playlists
516
- # in one bucket and thumbnails in another bucket, specify which
517
- # users can access the transcoded files or the permissions the
518
- # users have, or change the Amazon S3 storage class, omit
519
- # OutputBucket and specify values for ContentConfig and
520
- # ThumbnailConfig instead.
521
- # * `:storage_class` - (String) The Amazon S3 storage class, Standard
522
- # or ReducedRedundancy, that you want Elastic Transcoder to assign
523
- # to the video files and playlists that it stores in your Amazon S3
524
- # bucket.
525
- # * `:permissions` - (Array<Hash>) Optional. The Permissions object
526
- # specifies which users and/or predefined Amazon S3 groups you want
527
- # to have access to transcoded files and playlists, and the type of
528
- # access you want them to have. You can grant permissions to a
529
- # maximum of 30 users and/or predefined Amazon S3 groups. If you
530
- # include Permissions, Elastic Transcoder grants only the
531
- # permissions that you specify. It does not grant full permissions
532
- # to the owner of the role specified by Role. If you want that user
533
- # to have full control, you must explicitly grant full control to
534
- # the user. If you omit Permissions, Elastic Transcoder grants full
535
- # control over the transcoded files and playlists to the owner of
536
- # the role specified by Role, and grants no other permissions to
537
- # any other user or group.
538
- # * `:grantee_type` - (String) The type of value that appears in
539
- # the Grantee object: Canonical: Either the canonical user ID for
540
- # an AWS account or an origin access identity for an Amazon
541
- # CloudFront distribution. A canonical user ID is not the same as
542
- # an AWS account number. Email: The registered email address of
543
- # an AWS account. Group: One of the following predefined Amazon
544
- # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
545
- # * `:grantee` - (String) The AWS user or group that you want to
546
- # have access to transcoded files and playlists. To identify the
547
- # user or group, you can specify the canonical user ID for an AWS
548
- # account, an origin access identity for a CloudFront
549
- # distribution, the registered email address of an AWS account,
550
- # or a predefined Amazon S3 group.
551
- # * `:access` - (Array<String>) The permission that you want to
552
- # give to the AWS user that is listed in Grantee. Valid values
553
- # include: READ: The grantee can read the thumbnails and metadata
554
- # for thumbnails that Elastic Transcoder adds to the Amazon S3
555
- # bucket. READ_ACP: The grantee can read the object ACL for
556
- # thumbnails that Elastic Transcoder adds to the Amazon S3
557
- # bucket. WRITE_ACP: The grantee can write the ACL for the
558
- # thumbnails that Elastic Transcoder adds to the Amazon S3
559
- # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
560
- # WRITE_ACP permissions for the thumbnails that Elastic
561
- # Transcoder adds to the Amazon S3 bucket.
562
- # @return [Core::Response]
563
- # The #data method of the response object returns
564
- # a hash with the following structure:
565
- #
566
- # * `:pipeline` - (Hash)
567
- # * `:id` - (String)
568
- # * `:arn` - (String)
569
- # * `:name` - (String)
570
- # * `:status` - (String)
571
- # * `:input_bucket` - (String)
572
- # * `:output_bucket` - (String)
573
- # * `:role` - (String)
574
- # * `:notifications` - (Hash)
575
- # * `:progressing` - (String)
576
- # * `:completed` - (String)
577
- # * `:warning` - (String)
578
- # * `:error` - (String)
579
- # * `:content_config` - (Hash)
580
- # * `:bucket` - (String)
581
- # * `:storage_class` - (String)
582
- # * `:permissions` - (Array<Hash>)
583
- # * `:grantee_type` - (String)
584
- # * `:grantee` - (String)
585
- # * `:access` - (Array<String>)
586
- # * `:thumbnail_config` - (Hash)
587
- # * `:bucket` - (String)
588
- # * `:storage_class` - (String)
589
- # * `:permissions` - (Array<Hash>)
590
- # * `:grantee_type` - (String)
591
- # * `:grantee` - (String)
592
- # * `:access` - (Array<String>)
593
-
594
- # @!method create_preset(options = {})
595
- # Calls the POST CreatePreset API operation.
596
- # @param [Hash] options
597
- #
598
- # * `:name` - (String) The name of the preset. We recommend that the
599
- # name be unique within the AWS account, but uniqueness is not
600
- # enforced.
601
- # * `:description` - (String) A description of the preset.
602
- # * `:container` - (String) The container type for the output file.
603
- # This value must be mp4.
604
- # * `:video` - (Hash) A section of the request body that specifies the
605
- # video parameters.
606
- # * `:codec` - (String) The video codec for the output file. Valid
607
- # values include H.264 and vp8. You can only specify vp8 when the
608
- # container type is webm.
609
- # * `:codec_options` - (Hash) Profile The H.264 profile that you want
610
- # to use for the output file. Elastic Transcoder supports the
611
- # following profiles: baseline: The profile most commonly used for
612
- # videoconferencing and for mobile applications. main: The profile
613
- # used for standard-definition digital TV broadcasts. high: The
614
- # profile used for high-definition digital TV broadcasts and for
615
- # Blu-ray discs. Level (H.264 Only) The H.264 level that you want
616
- # to use for the output file. Elastic Transcoder supports the
617
- # following levels: 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2,
618
- # 4, 4.1 MaxReferenceFrames (H.264 Only) Applicable only when the
619
- # value of Video:Codec is H.264. The maximum number of previously
620
- # decoded frames to use as a reference for decoding future frames.
621
- # Valid values are integers 0 through 16, but we recommend that you
622
- # not use a value greater than the following: Min(Floor(Maximum
623
- # decoded picture buffer in macroblocks * 256 / (Width in pixels *
624
- # Height in pixels)), 16) where Width in pixels and Height in
625
- # pixels represent either MaxWidth and MaxHeight, or Resolution.
626
- # Maximum decoded picture buffer in macroblocks depends on the
627
- # value of the Level object. See the list below. (A macroblock is a
628
- # block of pixels measuring 16x16.) 1 - 396 1b - 396 1.1 - 900 1.2
629
- # - 2376 1.3 - 2376 2 - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 -
630
- # 18000 3.2 - 20480 4 - 32768 4.1 - 32768 MaxBitRate The maximum
631
- # number of bits per second in a video buffer; the size of the
632
- # buffer is specified by BufferSize. Specify a value between 16 and
633
- # 62,500. You can reduce the bandwidth required to stream a video
634
- # by reducing the maximum bit rate, but this also reduces the
635
- # quality of the video. BufferSize The maximum number of bits in
636
- # any x seconds of the output video. This window is commonly 10
637
- # seconds, the standard segment duration when you’re using MPEG-TS
638
- # for the container type of the output video. Specify an integer
639
- # greater than 0. If you specify MaxBitRate and omit BufferSize,
640
- # Elastic Transcoder sets BufferSize to 10 times the value of
641
- # MaxBitRate.
642
- # * `:keyframes_max_dist` - (String) The maximum number of frames
643
- # between key frames. Key frames are fully encoded frames; the
644
- # frames between key frames are encoded based, in part, on the
645
- # content of the key frames. The value is an integer formatted as a
646
- # string; valid values are between 1 (every frame is a key frame)
647
- # and 100000, inclusive. A higher value results in higher
648
- # compression but may also discernibly decrease video quality.
649
- # * `:fixed_gop` - (String) Whether to use a fixed value for
650
- # FixedGOP. Valid values are `true` and `false` : `true` : Elastic
651
- # Transcoder uses the value of KeyframesMaxDist for the distance
652
- # between key frames (the number of frames in a group of pictures,
653
- # or GOP). `false` : The distance between key frames can vary.
654
- # * `:bit_rate` - (String) The bit rate of the video stream in the
655
- # output file, in kilobits/second. Valid values depend on the
656
- # values of Level and Profile. If you specify auto, Elastic
657
- # Transcoder uses the detected bit rate of the input source. If you
658
- # specify a value other than auto, we recommend that you specify a
659
- # value less than or equal to the maximum H.264-compliant value
660
- # listed for your level and profile: Level - Maximum video bit rate
661
- # in kilobits/second (baseline and main Profile) : maximum video
662
- # bit rate in kilobits/second (high Profile) 1 - 64 : 80 1b - 128 :
663
- # 160 1.1 - 192 : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 :
664
- # 2500 3 - 10000 : 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4
665
- # - 20000 : 25000 4.1 - 50000 : 62500
666
- # * `:frame_rate` - (String) The frames per second for the video
667
- # stream in the output file. Valid values include: auto, 10, 15,
668
- # 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic
669
- # Transcoder uses the detected frame rate of the input source. If
670
- # you specify a frame rate, we recommend that you perform the
671
- # following calculation: Frame rate = maximum recommended decoding
672
- # speed in luma samples/second / (width in pixels * height in
673
- # pixels) where: width in pixels and height in pixels represent the
674
- # Resolution of the output video. maximum recommended decoding
675
- # speed in Luma samples/second is less than or equal to the maximum
676
- # value listed in the following table, based on the value that you
677
- # specified for Level. The maximum recommended decoding speed in
678
- # Luma samples/second for each level is described in the following
679
- # list (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800
680
- # 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 -
681
- # 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560
682
- # 4.1 - 62914560
683
- # * `:max_frame_rate` - (String) If you specify auto for FrameRate,
684
- # Elastic Transcoder uses the frame rate of the input video for the
685
- # frame rate of the output video. Specify the maximum frame rate
686
- # that you want Elastic Transcoder to use when the frame rate of
687
- # the input video is greater than the desired maximum frame rate of
688
- # the output video. Valid values include: 10, 15, 23.97, 24, 25,
689
- # 29.97, 30, 60.
690
- # * `:resolution` - (String) To better control resolution and aspect
691
- # ratio of output videos, we recommend that you use the values
692
- # MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
693
- # DisplayAspectRatio instead of Resolution and AspectRatio. The two
694
- # groups of settings are mutually exclusive. Do not use them
695
- # together. The width and height of the video in the output file,
696
- # in pixels. Valid values are auto and width x height: auto:
697
- # Elastic Transcoder attempts to preserve the width and height of
698
- # the input file, subject to the following rules. width x height:
699
- # The width and height of the output video in pixels. Note the
700
- # following about specifying the width and height: The width must
701
- # be an even integer between 128 and 4096, inclusive. The height
702
- # must be an even integer between 96 and 3072, inclusive. If you
703
- # specify a resolution that is less than the resolution of the
704
- # input file, Elastic Transcoder rescales the output file to the
705
- # lower resolution. If you specify a resolution that is greater
706
- # than the resolution of the input file, Elastic Transcoder
707
- # rescales the output to the higher resolution. We recommend that
708
- # you specify a resolution for which the product of width and
709
- # height is less than or equal to the applicable value in the
710
- # following list (List - Max width x height value): 1 - 25344 1b -
711
- # 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 -
712
- # 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 -
713
- # 2097152 4.1 - 2097152
714
- # * `:aspect_ratio` - (String) To better control resolution and
715
- # aspect ratio of output videos, we recommend that you use the
716
- # values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
717
- # DisplayAspectRatio instead of Resolution and AspectRatio. The two
718
- # groups of settings are mutually exclusive. Do not use them
719
- # together. The display aspect ratio of the video in the output
720
- # file. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you
721
- # specify auto, Elastic Transcoder tries to preserve the aspect
722
- # ratio of the input file. If you specify an aspect ratio for the
723
- # output file that differs from aspect ratio of the input file,
724
- # Elastic Transcoder adds pillarboxing (black bars on the sides) or
725
- # letterboxing (black bars on the top and bottom) to maintain the
726
- # aspect ratio of the active region of the video.
727
- # * `:max_width` - (String) The maximum width of the output video in
728
- # pixels. If you specify auto, Elastic Transcoder uses 1920 (Full
729
- # HD) as the default value. If you specify a numeric value, enter
730
- # an even integer between 128 and 4096.
731
- # * `:max_height` - (String) The maximum height of the output video
732
- # in pixels. If you specify auto, Elastic Transcoder uses 1080
733
- # (Full HD) as the default value. If you specify a numeric value,
734
- # enter an even integer between 96 and 3072.
735
- # * `:display_aspect_ratio` - (String) The value that Elastic
736
- # Transcoder adds to the metadata in the output file.
737
- # * `:sizing_policy` - (String) Specify one of the following values
738
- # to control scaling of the output video: Fit: Elastic Transcoder
739
- # scales the output video so it matches the value that you
740
- # specified in either MaxWidth or MaxHeight without exceeding the
741
- # other value. Fill: Elastic Transcoder scales the output video so
742
- # it matches the value that you specified in either MaxWidth or
743
- # MaxHeight and matches or exceeds the other value. Elastic
744
- # Transcoder centers the output video and then crops it in the
745
- # dimension (if any) that exceeds the maximum value. Stretch:
746
- # Elastic Transcoder stretches the output video to match the values
747
- # that you specified for MaxWidth and MaxHeight. If the relative
748
- # proportions of the input video and the output video are
749
- # different, the output video will be distorted. Keep: Elastic
750
- # Transcoder does not scale the output video. If either dimension
751
- # of the input video exceeds the values that you specified for
752
- # MaxWidth and MaxHeight, Elastic Transcoder crops the output
753
- # video. ShrinkToFit: Elastic Transcoder scales the output video
754
- # down so that its dimensions match the values that you specified
755
- # for at least one of MaxWidth and MaxHeight without exceeding
756
- # either value. If you specify this option, Elastic Transcoder does
757
- # not scale the video up. ShrinkToFill: Elastic Transcoder scales
758
- # the output video down so that its dimensions match the values
759
- # that you specified for at least one of MaxWidth and MaxHeight
760
- # without dropping below either value. If you specify this option,
761
- # Elastic Transcoder does not scale the video up.
762
- # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
763
- # Elastic Transcoder may add black bars to the top and bottom
764
- # and/or left and right sides of the output video to make the total
765
- # size of the output video match the values that you specified for
766
- # MaxWidth and MaxHeight.
767
- # * `:watermarks` - (Array<Hash>) Settings for the size, location,
768
- # and opacity of graphics that you want Elastic Transcoder to
769
- # overlay over videos that are transcoded using this preset. You
770
- # can specify settings for up to four watermarks. Watermarks appear
771
- # in the specified size and location, and with the specified
772
- # opacity for the duration of the transcoded video. Watermarks can
773
- # be in .png or .jpg format. If you want to display a watermark
774
- # that is not rectangular, use the .png format, which supports
775
- # transparency. When you create a job that uses this preset, you
776
- # specify the .png or .jpg graphics that you want Elastic
777
- # Transcoder to include in the transcoded videos. You can specify
778
- # fewer graphics in the job than you specify watermark settings in
779
- # the preset, which allows you to use the same preset for up to
780
- # four watermarks that have different dimensions.
781
- # * `:id` - (String) A unique identifier for the settings for one
782
- # watermark. The value of Id can be up to 40 characters long.
783
- # * `:max_width` - (String) The maximum width of the watermark in
784
- # one of the following formats: number of pixels (px): The
785
- # minimum value is 16 pixels, and the maximum value is the value
786
- # of MaxWidth. integer percentage (%): The range of valid values
787
- # is 0 to 100. Use the value of Target to specify whether you
788
- # want Elastic Transcoder to include the black bars that are
789
- # added by Elastic Transcoder, if any, in the calculation. If you
790
- # specify the value in pixels, it must be less than or equal to
791
- # the value of MaxWidth.
792
- # * `:max_height` - (String) The maximum height of the watermark in
793
- # one of the following formats: number of pixels (px): The
794
- # minimum value is 16 pixels, and the maximum value is the value
795
- # of MaxHeight. integer percentage (%): The range of valid values
796
- # is 0 to 100. Use the value of Target to specify whether you
797
- # want Elastic Transcoder to include the black bars that are
798
- # added by Elastic Transcoder, if any, in the calculation. If you
799
- # specify the value in pixels, it must be less than or equal to
800
- # the value of MaxHeight.
801
- # * `:sizing_policy` - (String) A value that controls scaling of
802
- # the watermark: Fit: Elastic Transcoder scales the watermark so
803
- # it matches the value that you specified in either MaxWidth or
804
- # MaxHeight without exceeding the other value. Stretch: Elastic
805
- # Transcoder stretches the watermark to match the values that you
806
- # specified for MaxWidth and MaxHeight. If the relative
807
- # proportions of the watermark and the values of MaxWidth and
808
- # MaxHeight are different, the watermark will be distorted.
809
- # ShrinkToFit: Elastic Transcoder scales the watermark down so
810
- # that its dimensions match the values that you specified for at
811
- # least one of MaxWidth and MaxHeight without exceeding either
812
- # value. If you specify this option, Elastic Transcoder does not
813
- # scale the watermark up.
814
- # * `:horizontal_align` - (String) The horizontal position of the
815
- # watermark unless you specify a non-zero value for
816
- # HorizontalOffset: Left: The left edge of the watermark is
817
- # aligned with the left border of the video. Right: The right
818
- # edge of the watermark is aligned with the right border of the
819
- # video. Center: The watermark is centered between the left and
820
- # right borders.
821
- # * `:horizontal_offset` - (String) The amount by which you want
822
- # the horizontal position of the watermark to be offset from the
823
- # position specified by HorizontalAlign: number of pixels (px):
824
- # The minimum value is 0 pixels, and the maximum value is the
825
- # value of MaxWidth. integer percentage (%): The range of valid
826
- # values is 0 to 100. For example, if you specify Left for
827
- # HorizontalAlign and 5px for HorizontalOffset, the left side of
828
- # the watermark appears 5 pixels from the left border of the
829
- # output video. HorizontalOffset is only valid when the value of
830
- # HorizontalAlign is Left or Right. If you specify an offset that
831
- # causes the watermark to extend beyond the left or right border
832
- # and Elastic Transcoder has not added black bars, the watermark
833
- # is cropped. If Elastic Transcoder has added black bars, the
834
- # watermark extends into the black bars. If the watermark extends
835
- # beyond the black bars, it is cropped. Use the value of Target
836
- # to specify whether you want to include the black bars that are
837
- # added by Elastic Transcoder, if any, in the offset calculation.
838
- # * `:vertical_align` - (String) The vertical position of the
839
- # watermark unless you specify a non-zero value for
840
- # VerticalOffset: Top: The top edge of the watermark is aligned
841
- # with the top border of the video. Bottom: The bottom edge of
842
- # the watermark is aligned with the bottom border of the video.
843
- # Center: The watermark is centered between the top and bottom
844
- # borders.
845
- # * `:vertical_offset` - (String) VerticalOffset The amount by
846
- # which you want the vertical position of the watermark to be
847
- # offset from the position specified by VerticalAlign: number of
848
- # pixels (px): The minimum value is 0 pixels, and the maximum
849
- # value is the value of MaxHeight. integer percentage (%): The
850
- # range of valid values is 0 to 100. For example, if you specify
851
- # Top for VerticalAlign and 5px for VerticalOffset, the top of
852
- # the watermark appears 5 pixels from the top border of the
853
- # output video. VerticalOffset is only valid when the value of
854
- # VerticalAlign is Top or Bottom. If you specify an offset that
855
- # causes the watermark to extend beyond the top or bottom border
856
- # and Elastic Transcoder has not added black bars, the watermark
857
- # is cropped. If Elastic Transcoder has added black bars, the
858
- # watermark extends into the black bars. If the watermark extends
859
- # beyond the black bars, it is cropped. Use the value of Target
860
- # to specify whether you want Elastic Transcoder to include the
861
- # black bars that are added by Elastic Transcoder, if any, in the
862
- # offset calculation.
863
- # * `:opacity` - (String) A percentage that indicates how much you
864
- # want a watermark to obscure the video in the location where it
865
- # appears. Valid values are 0 (the watermark is invisible) to 100
866
- # (the watermark completely obscures the video in the specified
867
- # location). The datatype of Opacity is float. Elastic Transcoder
868
- # supports transparent .png graphics. If you use a transparent
869
- # .png, the transparent portion of the video appears as if you
870
- # had specified a value of 0 for Opacity. The .jpg file format
871
- # doesn't support transparency.
872
- # * `:target` - (String) A value that determines how Elastic
873
- # Transcoder interprets values that you specified for
874
- # HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:
875
- # Content: HorizontalOffset and VerticalOffset values are
876
- # calculated based on the borders of the video excluding black
877
- # bars added by Elastic Transcoder, if any. In addition, MaxWidth
878
- # and MaxHeight, if specified as a percentage, are calculated
879
- # based on the borders of the video excluding black bars added by
880
- # Elastic Transcoder, if any. Frame: HorizontalOffset and
881
- # VerticalOffset values are calculated based on the borders of
882
- # the video including black bars added by Elastic Transcoder, if
883
- # any. In addition, MaxWidth and MaxHeight, if specified as a
884
- # percentage, are calculated based on the borders of the video
885
- # including black bars added by Elastic Transcoder, if any.
886
- # * `:audio` - (Hash) A section of the request body that specifies the
887
- # audio parameters.
888
- # * `:codec` - (String) The audio codec for the output file. This
889
- # value must be AAC.
890
- # * `:sample_rate` - (String) The sample rate of the audio stream in
891
- # the output file, in Hertz. Valid values include: auto, 22050,
892
- # 32000, 44100, 48000, 96000 If you specify auto, Elastic
893
- # Transcoder automatically detects the sample rate.
894
- # * `:bit_rate` - (String) The bit rate of the audio stream in the
895
- # output file, in kilobits/second. Enter an integer between 64 and
896
- # 320, inclusive.
897
- # * `:channels` - (String) The number of audio channels in the output
898
- # file. Valid values include: auto, 0, 1, 2 If you specify auto,
899
- # Elastic Transcoder automatically detects the number of channels
900
- # in the input file.
901
- # * `:thumbnails` - (Hash) A section of the request body that specifies
902
- # the thumbnail parameters, if any.
903
- # * `:format` - (String) The format of thumbnails, if any. Valid
904
- # values are jpg and png. You specify whether you want Elastic
905
- # Transcoder to create thumbnails when you create a job.
906
- # * `:interval` - (String) The number of seconds between thumbnails.
907
- # Specify an integer value.
908
- # * `:resolution` - (String) To better control resolution and aspect
909
- # ratio of thumbnails, we recommend that you use the values
910
- # MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of
911
- # Resolution and AspectRatio. The two groups of settings are
912
- # mutually exclusive. Do not use them together. The width and
913
- # height of thumbnail files in pixels. Specify a value in the
914
- # format width x height where both values are even integers. The
915
- # values cannot exceed the width and height that you specified in
916
- # the Video:Resolution object.
917
- # * `:aspect_ratio` - (String) To better control resolution and
918
- # aspect ratio of thumbnails, we recommend that you use the values
919
- # MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of
920
- # Resolution and AspectRatio. The two groups of settings are
921
- # mutually exclusive. Do not use them together. The aspect ratio of
922
- # thumbnails. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If
923
- # you specify auto, Elastic Transcoder tries to preserve the aspect
924
- # ratio of the video in the output file.
925
- # * `:max_width` - (String) The maximum width of thumbnails in
926
- # pixels. If you specify auto, Elastic Transcoder uses 1920 (Full
927
- # HD) as the default value. If you specify a numeric value, enter
928
- # an even integer between 32 and 4096.
929
- # * `:max_height` - (String) The maximum height of thumbnails in
930
- # pixels. If you specify auto, Elastic Transcoder uses 1080 (Full
931
- # HD) as the default value. If you specify a numeric value, enter
932
- # an even integer between 32 and 3072.
933
- # * `:sizing_policy` - (String) Specify one of the following values
934
- # to control scaling of thumbnails: Fit: Elastic Transcoder scales
935
- # thumbnails so they match the value that you specified in
936
- # thumbnail MaxWidth or MaxHeight settings without exceeding the
937
- # other value. Fill: Elastic Transcoder scales thumbnails so they
938
- # match the value that you specified in thumbnail MaxWidth or
939
- # MaxHeight settings and matches or exceeds the other value.
940
- # Elastic Transcoder centers the image in thumbnails and then crops
941
- # in the dimension (if any) that exceeds the maximum value.
942
- # Stretch: Elastic Transcoder stretches thumbnails to match the
943
- # values that you specified for thumbnail MaxWidth and MaxHeight
944
- # settings. If the relative proportions of the input video and
945
- # thumbnails are different, the thumbnails will be distorted. Keep:
946
- # Elastic Transcoder does not scale thumbnails. If either dimension
947
- # of the input video exceeds the values that you specified for
948
- # thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder
949
- # crops the thumbnails. ShrinkToFit: Elastic Transcoder scales
950
- # thumbnails down so that their dimensions match the values that
951
- # you specified for at least one of thumbnail MaxWidth and
952
- # MaxHeight without exceeding either value. If you specify this
953
- # option, Elastic Transcoder does not scale thumbnails up.
954
- # ShrinkToFill: Elastic Transcoder scales thumbnails down so that
955
- # their dimensions match the values that you specified for at least
956
- # one of MaxWidth and MaxHeight without dropping below either
957
- # value. If you specify this option, Elastic Transcoder does not
958
- # scale thumbnails up.
959
- # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
960
- # Elastic Transcoder may add black bars to the top and bottom
961
- # and/or left and right sides of thumbnails to make the total size
962
- # of the thumbnails match the values that you specified for
963
- # thumbnail MaxWidth and MaxHeight settings.
964
- # @return [Core::Response]
965
- # The #data method of the response object returns
966
- # a hash with the following structure:
967
- #
968
- # * `:preset` - (Hash)
969
- # * `:id` - (String)
970
- # * `:name` - (String)
971
- # * `:description` - (String)
972
- # * `:container` - (String)
973
- # * `:audio` - (Hash)
974
- # * `:codec` - (String)
975
- # * `:sample_rate` - (String)
976
- # * `:bit_rate` - (String)
977
- # * `:channels` - (String)
978
- # * `:video` - (Hash)
979
- # * `:codec` - (String)
980
- # * `:codec_options` - (Hash<String,String>)
981
- # * `:keyframes_max_dist` - (String)
982
- # * `:fixed_gop` - (String)
983
- # * `:bit_rate` - (String)
984
- # * `:frame_rate` - (String)
985
- # * `:max_frame_rate` - (String)
986
- # * `:resolution` - (String)
987
- # * `:aspect_ratio` - (String)
988
- # * `:max_width` - (String)
989
- # * `:max_height` - (String)
990
- # * `:display_aspect_ratio` - (String)
991
- # * `:sizing_policy` - (String)
992
- # * `:padding_policy` - (String)
993
- # * `:watermarks` - (Array<Hash>)
994
- # * `:id` - (String)
995
- # * `:max_width` - (String)
996
- # * `:max_height` - (String)
997
- # * `:sizing_policy` - (String)
998
- # * `:horizontal_align` - (String)
999
- # * `:horizontal_offset` - (String)
1000
- # * `:vertical_align` - (String)
1001
- # * `:vertical_offset` - (String)
1002
- # * `:opacity` - (String)
1003
- # * `:target` - (String)
1004
- # * `:thumbnails` - (Hash)
1005
- # * `:format` - (String)
1006
- # * `:interval` - (String)
1007
- # * `:resolution` - (String)
1008
- # * `:aspect_ratio` - (String)
1009
- # * `:max_width` - (String)
1010
- # * `:max_height` - (String)
1011
- # * `:sizing_policy` - (String)
1012
- # * `:padding_policy` - (String)
1013
- # * `:type` - (String)
1014
- # * `:warning` - (String)
1015
-
1016
- # @!method delete_pipeline(options = {})
1017
- # Calls the DELETE DeletePipeline API operation.
1018
- # @param [Hash] options
1019
- #
1020
- # * `:id` - *required* - (String) The identifier of the pipeline that
1021
- # you want to delete.
1022
- # @return [Core::Response]
1023
-
1024
- # @!method delete_preset(options = {})
1025
- # Calls the DELETE DeletePreset API operation.
1026
- # @param [Hash] options
1027
- #
1028
- # * `:id` - *required* - (String) The identifier of the preset for
1029
- # which you want to get detailed information.
1030
- # @return [Core::Response]
1031
-
1032
- # @!method list_jobs_by_pipeline(options = {})
1033
- # Calls the GET ListJobsByPipeline API operation.
1034
- # @param [Hash] options
1035
- #
1036
- # * `:pipeline_id` - *required* - (String) The ID of the pipeline for
1037
- # which you want to get job information.
1038
- # * `:ascending` - (String) To list jobs in chronological order by the
1039
- # date and time that they were submitted, enter `true` . To list jobs
1040
- # in reverse chronological order, enter `false` .
1041
- # * `:page_token` - (String) When Elastic Transcoder returns more than
1042
- # one page of results, use pageToken in subsequent GET requests to
1043
- # get each successive page of results.
1044
- # @return [Core::Response]
1045
- # The #data method of the response object returns
1046
- # a hash with the following structure:
1047
- #
1048
- # * `:jobs` - (Array<Hash>)
1049
- # * `:id` - (String)
1050
- # * `:pipeline_id` - (String)
1051
- # * `:input` - (Hash)
1052
- # * `:key` - (String)
1053
- # * `:frame_rate` - (String)
1054
- # * `:resolution` - (String)
1055
- # * `:aspect_ratio` - (String)
1056
- # * `:interlaced` - (String)
1057
- # * `:container` - (String)
1058
- # * `:output` - (Hash)
1059
- # * `:id` - (String)
1060
- # * `:key` - (String)
1061
- # * `:thumbnail_pattern` - (String)
1062
- # * `:rotate` - (String)
1063
- # * `:preset_id` - (String)
1064
- # * `:segment_duration` - (String)
1065
- # * `:status` - (String)
1066
- # * `:status_detail` - (String)
1067
- # * `:duration` - (Integer)
1068
- # * `:width` - (Integer)
1069
- # * `:height` - (Integer)
1070
- # * `:watermarks` - (Array<Hash>)
1071
- # * `:preset_watermark_id` - (String)
1072
- # * `:input_key` - (String)
1073
- # * `:outputs` - (Array<Hash>)
1074
- # * `:id` - (String)
1075
- # * `:key` - (String)
1076
- # * `:thumbnail_pattern` - (String)
1077
- # * `:rotate` - (String)
1078
- # * `:preset_id` - (String)
1079
- # * `:segment_duration` - (String)
1080
- # * `:status` - (String)
1081
- # * `:status_detail` - (String)
1082
- # * `:duration` - (Integer)
1083
- # * `:width` - (Integer)
1084
- # * `:height` - (Integer)
1085
- # * `:watermarks` - (Array<Hash>)
1086
- # * `:preset_watermark_id` - (String)
1087
- # * `:input_key` - (String)
1088
- # * `:output_key_prefix` - (String)
1089
- # * `:playlists` - (Array<Hash>)
1090
- # * `:name` - (String)
1091
- # * `:format` - (String)
1092
- # * `:output_keys` - (Array<String>)
1093
- # * `:status` - (String)
1094
- # * `:status_detail` - (String)
1095
- # * `:status` - (String)
1096
- # * `:next_page_token` - (String)
1097
-
1098
- # @!method list_jobs_by_status(options = {})
1099
- # Calls the GET ListJobsByStatus API operation.
1100
- # @param [Hash] options
1101
- #
1102
- # * `:status` - *required* - (String) To get information about all of
1103
- # the jobs associated with the current AWS account that have a given
1104
- # status, specify the following status: Submitted, Progressing,
1105
- # Complete, Canceled, or Error.
1106
- # * `:ascending` - (String) To list jobs in chronological order by the
1107
- # date and time that they were submitted, enter `true` . To list jobs
1108
- # in reverse chronological order, enter `false` .
1109
- # * `:page_token` - (String) When Elastic Transcoder returns more than
1110
- # one page of results, use pageToken in subsequent GET requests to
1111
- # get each successive page of results.
1112
- # @return [Core::Response]
1113
- # The #data method of the response object returns
1114
- # a hash with the following structure:
1115
- #
1116
- # * `:jobs` - (Array<Hash>)
1117
- # * `:id` - (String)
1118
- # * `:pipeline_id` - (String)
1119
- # * `:input` - (Hash)
1120
- # * `:key` - (String)
1121
- # * `:frame_rate` - (String)
1122
- # * `:resolution` - (String)
1123
- # * `:aspect_ratio` - (String)
1124
- # * `:interlaced` - (String)
1125
- # * `:container` - (String)
1126
- # * `:output` - (Hash)
1127
- # * `:id` - (String)
1128
- # * `:key` - (String)
1129
- # * `:thumbnail_pattern` - (String)
1130
- # * `:rotate` - (String)
1131
- # * `:preset_id` - (String)
1132
- # * `:segment_duration` - (String)
1133
- # * `:status` - (String)
1134
- # * `:status_detail` - (String)
1135
- # * `:duration` - (Integer)
1136
- # * `:width` - (Integer)
1137
- # * `:height` - (Integer)
1138
- # * `:watermarks` - (Array<Hash>)
1139
- # * `:preset_watermark_id` - (String)
1140
- # * `:input_key` - (String)
1141
- # * `:outputs` - (Array<Hash>)
1142
- # * `:id` - (String)
1143
- # * `:key` - (String)
1144
- # * `:thumbnail_pattern` - (String)
1145
- # * `:rotate` - (String)
1146
- # * `:preset_id` - (String)
1147
- # * `:segment_duration` - (String)
1148
- # * `:status` - (String)
1149
- # * `:status_detail` - (String)
1150
- # * `:duration` - (Integer)
1151
- # * `:width` - (Integer)
1152
- # * `:height` - (Integer)
1153
- # * `:watermarks` - (Array<Hash>)
1154
- # * `:preset_watermark_id` - (String)
1155
- # * `:input_key` - (String)
1156
- # * `:output_key_prefix` - (String)
1157
- # * `:playlists` - (Array<Hash>)
1158
- # * `:name` - (String)
1159
- # * `:format` - (String)
1160
- # * `:output_keys` - (Array<String>)
1161
- # * `:status` - (String)
1162
- # * `:status_detail` - (String)
1163
- # * `:status` - (String)
1164
- # * `:next_page_token` - (String)
1165
-
1166
- # @!method list_pipelines(options = {})
1167
- # Calls the GET ListPipelines API operation.
1168
- # @param [Hash] options
1169
- #
1170
- # @return [Core::Response]
1171
- # The #data method of the response object returns
1172
- # a hash with the following structure:
1173
- #
1174
- # * `:pipelines` - (Array<Hash>)
1175
- # * `:id` - (String)
1176
- # * `:arn` - (String)
1177
- # * `:name` - (String)
1178
- # * `:status` - (String)
1179
- # * `:input_bucket` - (String)
1180
- # * `:output_bucket` - (String)
1181
- # * `:role` - (String)
1182
- # * `:notifications` - (Hash)
1183
- # * `:progressing` - (String)
1184
- # * `:completed` - (String)
1185
- # * `:warning` - (String)
1186
- # * `:error` - (String)
1187
- # * `:content_config` - (Hash)
1188
- # * `:bucket` - (String)
1189
- # * `:storage_class` - (String)
1190
- # * `:permissions` - (Array<Hash>)
1191
- # * `:grantee_type` - (String)
1192
- # * `:grantee` - (String)
1193
- # * `:access` - (Array<String>)
1194
- # * `:thumbnail_config` - (Hash)
1195
- # * `:bucket` - (String)
1196
- # * `:storage_class` - (String)
1197
- # * `:permissions` - (Array<Hash>)
1198
- # * `:grantee_type` - (String)
1199
- # * `:grantee` - (String)
1200
- # * `:access` - (Array<String>)
1201
-
1202
- # @!method list_presets(options = {})
1203
- # Calls the GET ListPresets API operation.
1204
- # @param [Hash] options
1205
- #
1206
- # @return [Core::Response]
1207
- # The #data method of the response object returns
1208
- # a hash with the following structure:
1209
- #
1210
- # * `:presets` - (Array<Hash>)
1211
- # * `:id` - (String)
1212
- # * `:name` - (String)
1213
- # * `:description` - (String)
1214
- # * `:container` - (String)
1215
- # * `:audio` - (Hash)
1216
- # * `:codec` - (String)
1217
- # * `:sample_rate` - (String)
1218
- # * `:bit_rate` - (String)
1219
- # * `:channels` - (String)
1220
- # * `:video` - (Hash)
1221
- # * `:codec` - (String)
1222
- # * `:codec_options` - (Hash<String,String>)
1223
- # * `:keyframes_max_dist` - (String)
1224
- # * `:fixed_gop` - (String)
1225
- # * `:bit_rate` - (String)
1226
- # * `:frame_rate` - (String)
1227
- # * `:max_frame_rate` - (String)
1228
- # * `:resolution` - (String)
1229
- # * `:aspect_ratio` - (String)
1230
- # * `:max_width` - (String)
1231
- # * `:max_height` - (String)
1232
- # * `:display_aspect_ratio` - (String)
1233
- # * `:sizing_policy` - (String)
1234
- # * `:padding_policy` - (String)
1235
- # * `:watermarks` - (Array<Hash>)
1236
- # * `:id` - (String)
1237
- # * `:max_width` - (String)
1238
- # * `:max_height` - (String)
1239
- # * `:sizing_policy` - (String)
1240
- # * `:horizontal_align` - (String)
1241
- # * `:horizontal_offset` - (String)
1242
- # * `:vertical_align` - (String)
1243
- # * `:vertical_offset` - (String)
1244
- # * `:opacity` - (String)
1245
- # * `:target` - (String)
1246
- # * `:thumbnails` - (Hash)
1247
- # * `:format` - (String)
1248
- # * `:interval` - (String)
1249
- # * `:resolution` - (String)
1250
- # * `:aspect_ratio` - (String)
1251
- # * `:max_width` - (String)
1252
- # * `:max_height` - (String)
1253
- # * `:sizing_policy` - (String)
1254
- # * `:padding_policy` - (String)
1255
- # * `:type` - (String)
1256
-
1257
- # @!method read_job(options = {})
1258
- # Calls the GET ReadJob API operation.
1259
- # @param [Hash] options
1260
- #
1261
- # * `:id` - *required* - (String) The identifier of the job for which
1262
- # you want to get detailed information.
1263
- # @return [Core::Response]
1264
- # The #data method of the response object returns
1265
- # a hash with the following structure:
1266
- #
1267
- # * `:job` - (Hash)
1268
- # * `:id` - (String)
1269
- # * `:pipeline_id` - (String)
1270
- # * `:input` - (Hash)
1271
- # * `:key` - (String)
1272
- # * `:frame_rate` - (String)
1273
- # * `:resolution` - (String)
1274
- # * `:aspect_ratio` - (String)
1275
- # * `:interlaced` - (String)
1276
- # * `:container` - (String)
1277
- # * `:output` - (Hash)
1278
- # * `:id` - (String)
1279
- # * `:key` - (String)
1280
- # * `:thumbnail_pattern` - (String)
1281
- # * `:rotate` - (String)
1282
- # * `:preset_id` - (String)
1283
- # * `:segment_duration` - (String)
1284
- # * `:status` - (String)
1285
- # * `:status_detail` - (String)
1286
- # * `:duration` - (Integer)
1287
- # * `:width` - (Integer)
1288
- # * `:height` - (Integer)
1289
- # * `:watermarks` - (Array<Hash>)
1290
- # * `:preset_watermark_id` - (String)
1291
- # * `:input_key` - (String)
1292
- # * `:outputs` - (Array<Hash>)
1293
- # * `:id` - (String)
1294
- # * `:key` - (String)
1295
- # * `:thumbnail_pattern` - (String)
1296
- # * `:rotate` - (String)
1297
- # * `:preset_id` - (String)
1298
- # * `:segment_duration` - (String)
1299
- # * `:status` - (String)
1300
- # * `:status_detail` - (String)
1301
- # * `:duration` - (Integer)
1302
- # * `:width` - (Integer)
1303
- # * `:height` - (Integer)
1304
- # * `:watermarks` - (Array<Hash>)
1305
- # * `:preset_watermark_id` - (String)
1306
- # * `:input_key` - (String)
1307
- # * `:output_key_prefix` - (String)
1308
- # * `:playlists` - (Array<Hash>)
1309
- # * `:name` - (String)
1310
- # * `:format` - (String)
1311
- # * `:output_keys` - (Array<String>)
1312
- # * `:status` - (String)
1313
- # * `:status_detail` - (String)
1314
- # * `:status` - (String)
1315
-
1316
- # @!method read_pipeline(options = {})
1317
- # Calls the GET ReadPipeline API operation.
1318
- # @param [Hash] options
1319
- #
1320
- # * `:id` - *required* - (String) The identifier of the pipeline to
1321
- # read.
1322
- # @return [Core::Response]
1323
- # The #data method of the response object returns
1324
- # a hash with the following structure:
1325
- #
1326
- # * `:pipeline` - (Hash)
1327
- # * `:id` - (String)
1328
- # * `:arn` - (String)
1329
- # * `:name` - (String)
1330
- # * `:status` - (String)
1331
- # * `:input_bucket` - (String)
1332
- # * `:output_bucket` - (String)
1333
- # * `:role` - (String)
1334
- # * `:notifications` - (Hash)
1335
- # * `:progressing` - (String)
1336
- # * `:completed` - (String)
1337
- # * `:warning` - (String)
1338
- # * `:error` - (String)
1339
- # * `:content_config` - (Hash)
1340
- # * `:bucket` - (String)
1341
- # * `:storage_class` - (String)
1342
- # * `:permissions` - (Array<Hash>)
1343
- # * `:grantee_type` - (String)
1344
- # * `:grantee` - (String)
1345
- # * `:access` - (Array<String>)
1346
- # * `:thumbnail_config` - (Hash)
1347
- # * `:bucket` - (String)
1348
- # * `:storage_class` - (String)
1349
- # * `:permissions` - (Array<Hash>)
1350
- # * `:grantee_type` - (String)
1351
- # * `:grantee` - (String)
1352
- # * `:access` - (Array<String>)
1353
-
1354
- # @!method read_preset(options = {})
1355
- # Calls the GET ReadPreset API operation.
1356
- # @param [Hash] options
1357
- #
1358
- # * `:id` - *required* - (String) The identifier of the preset for
1359
- # which you want to get detailed information.
1360
- # @return [Core::Response]
1361
- # The #data method of the response object returns
1362
- # a hash with the following structure:
1363
- #
1364
- # * `:preset` - (Hash)
1365
- # * `:id` - (String)
1366
- # * `:name` - (String)
1367
- # * `:description` - (String)
1368
- # * `:container` - (String)
1369
- # * `:audio` - (Hash)
1370
- # * `:codec` - (String)
1371
- # * `:sample_rate` - (String)
1372
- # * `:bit_rate` - (String)
1373
- # * `:channels` - (String)
1374
- # * `:video` - (Hash)
1375
- # * `:codec` - (String)
1376
- # * `:codec_options` - (Hash<String,String>)
1377
- # * `:keyframes_max_dist` - (String)
1378
- # * `:fixed_gop` - (String)
1379
- # * `:bit_rate` - (String)
1380
- # * `:frame_rate` - (String)
1381
- # * `:max_frame_rate` - (String)
1382
- # * `:resolution` - (String)
1383
- # * `:aspect_ratio` - (String)
1384
- # * `:max_width` - (String)
1385
- # * `:max_height` - (String)
1386
- # * `:display_aspect_ratio` - (String)
1387
- # * `:sizing_policy` - (String)
1388
- # * `:padding_policy` - (String)
1389
- # * `:watermarks` - (Array<Hash>)
1390
- # * `:id` - (String)
1391
- # * `:max_width` - (String)
1392
- # * `:max_height` - (String)
1393
- # * `:sizing_policy` - (String)
1394
- # * `:horizontal_align` - (String)
1395
- # * `:horizontal_offset` - (String)
1396
- # * `:vertical_align` - (String)
1397
- # * `:vertical_offset` - (String)
1398
- # * `:opacity` - (String)
1399
- # * `:target` - (String)
1400
- # * `:thumbnails` - (Hash)
1401
- # * `:format` - (String)
1402
- # * `:interval` - (String)
1403
- # * `:resolution` - (String)
1404
- # * `:aspect_ratio` - (String)
1405
- # * `:max_width` - (String)
1406
- # * `:max_height` - (String)
1407
- # * `:sizing_policy` - (String)
1408
- # * `:padding_policy` - (String)
1409
- # * `:type` - (String)
1410
-
1411
- # @!method test_role(options = {})
1412
- # Calls the POST TestRole API operation.
1413
- # @param [Hash] options
1414
- #
1415
- # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
1416
- # that you want Elastic Transcoder to test.
1417
- # * `:input_bucket` - (String) The Amazon S3 bucket that contains media
1418
- # files to be transcoded. The action attempts to read from this
1419
- # bucket.
1420
- # * `:output_bucket` - (String) The Amazon S3 bucket that Elastic
1421
- # Transcoder will write transcoded media files to. The action
1422
- # attempts to read from this bucket.
1423
- # * `:topics` - (Array<String>) The ARNs of one or more Amazon Simple
1424
- # Notification Service (Amazon SNS) topics that you want the action
1425
- # to send a test notification to.
1426
- # @return [Core::Response]
1427
- # The #data method of the response object returns
1428
- # a hash with the following structure:
1429
- #
1430
- # * `:success` - (String)
1431
- # * `:messages` - (Array<String>)
1432
-
1433
- # @!method update_pipeline(options = {})
1434
- # Calls the PUT UpdatePipeline API operation.
1435
- # @param [Hash] options
1436
- #
1437
- # * `:id` - *required* - (String) The ID of the pipeline that you want
1438
- # to update.
1439
- # * `:name` - (String) The name of the pipeline. We recommend that the
1440
- # name be unique within the AWS account, but uniqueness is not
1441
- # enforced. Constraints: Maximum 40 characters
1442
- # * `:input_bucket` - (String) The Amazon S3 bucket in which you saved
1443
- # the media files that you want to transcode and the graphics that
1444
- # you want to use as watermarks.
1445
- # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
1446
- # that you want Elastic Transcoder to use to transcode jobs for this
1447
- # pipeline.
1448
- # * `:notifications` - (Hash)
1449
- # * `:progressing` - (String) The Amazon Simple Notification Service
1450
- # (Amazon SNS) topic that you want to notify when Elastic
1451
- # Transcoder has started to process the job.
1452
- # * `:completed` - (String) The Amazon SNS topic that you want to
1453
- # notify when Elastic Transcoder has finished processing the job.
1454
- # * `:warning` - (String) The Amazon SNS topic that you want to
1455
- # notify when Elastic Transcoder encounters a warning condition.
1456
- # * `:error` - (String) The Amazon SNS topic that you want to notify
1457
- # when Elastic Transcoder encounters an error condition.
1458
- # * `:content_config` - (Hash) The optional ContentConfig object
1459
- # specifies information about the Amazon S3 bucket in which you want
1460
- # Elastic Transcoder to save transcoded files and playlists: which
1461
- # bucket to use, which users you want to have access to the files,
1462
- # the type of access you want users to have, and the storage class
1463
- # that you want to assign to the files. If you specify values for
1464
- # ContentConfig, you must also specify values for ThumbnailConfig. If
1465
- # you specify values for ContentConfig and ThumbnailConfig, omit the
1466
- # OutputBucket object. Bucket: The Amazon S3 bucket in which you want
1467
- # Elastic Transcoder to save transcoded files and playlists.
1468
- # Permissions (Optional): The Permissions object specifies which
1469
- # users you want to have access to transcoded files and the type of
1470
- # access you want them to have. You can grant permissions to a
1471
- # maximum of 30 users and/or predefined Amazon S3 groups. Grantee
1472
- # Type: Specify the type of value that appears in the Grantee object:
1473
- # Canonical: The value in the Grantee object is either the canonical
1474
- # user ID for an AWS account or an origin access identity for an
1475
- # Amazon CloudFront distribution. For more information about
1476
- # canonical user IDs, see Access Control List (ACL) Overview in the
1477
- # Amazon Simple Storage Service Developer Guide. For more information
1478
- # about using CloudFront origin access identities to require that
1479
- # users use CloudFront URLs instead of Amazon S3 URLs, see Using an
1480
- # Origin Access Identity to Restrict Access to Your Amazon S3
1481
- # Content. A canonical user ID is not the same as an AWS account
1482
- # number. Email: The value in the Grantee object is the registered
1483
- # email address of an AWS account. Group: The value in the Grantee
1484
- # object is one of the following predefined Amazon S3 groups:
1485
- # AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user
1486
- # or group that you want to have access to transcoded files and
1487
- # playlists. To identify the user or group, you can specify the
1488
- # canonical user ID for an AWS account, an origin access identity for
1489
- # a CloudFront distribution, the registered email address of an AWS
1490
- # account, or a predefined Amazon S3 group Access: The permission
1491
- # that you want to give to the AWS user that you specified in
1492
- # Grantee. Permissions are granted on the files that Elastic
1493
- # Transcoder adds to the bucket, including playlists and video files.
1494
- # Valid values include: READ: The grantee can read the objects and
1495
- # metadata for objects that Elastic Transcoder adds to the Amazon S3
1496
- # bucket. READ_ACP: The grantee can read the object ACL for objects
1497
- # that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP:
1498
- # The grantee can write the ACL for the objects that Elastic
1499
- # Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee
1500
- # has READ, READ_ACP, and WRITE_ACP permissions for the objects that
1501
- # Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The
1502
- # Amazon S3 storage class, Standard or ReducedRedundancy, that you
1503
- # want Elastic Transcoder to assign to the video files and playlists
1504
- # that it stores in your Amazon S3 bucket.
1505
- # * `:bucket` - (String) The Amazon S3 bucket in which you want
1506
- # Elastic Transcoder to save the transcoded files. Specify this
1507
- # value when all of the following are `true` : You want to save
1508
- # transcoded files, thumbnails (if any), and playlists (if any)
1509
- # together in one bucket. You do not want to specify the users or
1510
- # groups who have access to the transcoded files, thumbnails, and
1511
- # playlists. You do not want to specify the permissions that
1512
- # Elastic Transcoder grants to the files. You want to associate the
1513
- # transcoded files and thumbnails with the Amazon S3 Standard
1514
- # storage class. If you want to save transcoded files and playlists
1515
- # in one bucket and thumbnails in another bucket, specify which
1516
- # users can access the transcoded files or the permissions the
1517
- # users have, or change the Amazon S3 storage class, omit
1518
- # OutputBucket and specify values for ContentConfig and
1519
- # ThumbnailConfig instead.
1520
- # * `:storage_class` - (String) The Amazon S3 storage class, Standard
1521
- # or ReducedRedundancy, that you want Elastic Transcoder to assign
1522
- # to the video files and playlists that it stores in your Amazon S3
1523
- # bucket.
1524
- # * `:permissions` - (Array<Hash>) Optional. The Permissions object
1525
- # specifies which users and/or predefined Amazon S3 groups you want
1526
- # to have access to transcoded files and playlists, and the type of
1527
- # access you want them to have. You can grant permissions to a
1528
- # maximum of 30 users and/or predefined Amazon S3 groups. If you
1529
- # include Permissions, Elastic Transcoder grants only the
1530
- # permissions that you specify. It does not grant full permissions
1531
- # to the owner of the role specified by Role. If you want that user
1532
- # to have full control, you must explicitly grant full control to
1533
- # the user. If you omit Permissions, Elastic Transcoder grants full
1534
- # control over the transcoded files and playlists to the owner of
1535
- # the role specified by Role, and grants no other permissions to
1536
- # any other user or group.
1537
- # * `:grantee_type` - (String) The type of value that appears in
1538
- # the Grantee object: Canonical: Either the canonical user ID for
1539
- # an AWS account or an origin access identity for an Amazon
1540
- # CloudFront distribution. A canonical user ID is not the same as
1541
- # an AWS account number. Email: The registered email address of
1542
- # an AWS account. Group: One of the following predefined Amazon
1543
- # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
1544
- # * `:grantee` - (String) The AWS user or group that you want to
1545
- # have access to transcoded files and playlists. To identify the
1546
- # user or group, you can specify the canonical user ID for an AWS
1547
- # account, an origin access identity for a CloudFront
1548
- # distribution, the registered email address of an AWS account,
1549
- # or a predefined Amazon S3 group.
1550
- # * `:access` - (Array<String>) The permission that you want to
1551
- # give to the AWS user that is listed in Grantee. Valid values
1552
- # include: READ: The grantee can read the thumbnails and metadata
1553
- # for thumbnails that Elastic Transcoder adds to the Amazon S3
1554
- # bucket. READ_ACP: The grantee can read the object ACL for
1555
- # thumbnails that Elastic Transcoder adds to the Amazon S3
1556
- # bucket. WRITE_ACP: The grantee can write the ACL for the
1557
- # thumbnails that Elastic Transcoder adds to the Amazon S3
1558
- # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
1559
- # WRITE_ACP permissions for the thumbnails that Elastic
1560
- # Transcoder adds to the Amazon S3 bucket.
1561
- # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
1562
- # several values, including the Amazon S3 bucket in which you want
1563
- # Elastic Transcoder to save thumbnail files, which users you want to
1564
- # have access to the files, the type of access you want users to
1565
- # have, and the storage class that you want to assign to the files.
1566
- # If you specify values for ContentConfig, you must also specify
1567
- # values for ThumbnailConfig even if you don't want to create
1568
- # thumbnails. If you specify values for ContentConfig and
1569
- # ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon
1570
- # S3 bucket in which you want Elastic Transcoder to save thumbnail
1571
- # files. Permissions (Optional): The Permissions object specifies
1572
- # which users and/or predefined Amazon S3 groups you want to have
1573
- # access to thumbnail files, and the type of access you want them to
1574
- # have. You can grant permissions to a maximum of 30 users and/or
1575
- # predefined Amazon S3 groups. GranteeType: Specify the type of value
1576
- # that appears in the Grantee object: Canonical: The value in the
1577
- # Grantee object is either the canonical user ID for an AWS account
1578
- # or an origin access identity for an Amazon CloudFront distribution.
1579
- # A canonical user ID is not the same as an AWS account number.
1580
- # Email: The value in the Grantee object is the registered email
1581
- # address of an AWS account. Group: The value in the Grantee object
1582
- # is one of the following predefined Amazon S3 groups: AllUsers,
1583
- # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
1584
- # that you want to have access to thumbnail files. To identify the
1585
- # user or group, you can specify the canonical user ID for an AWS
1586
- # account, an origin access identity for a CloudFront distribution,
1587
- # the registered email address of an AWS account, or a predefined
1588
- # Amazon S3 group. Access: The permission that you want to give to
1589
- # the AWS user that you specified in Grantee. Permissions are granted
1590
- # on the thumbnail files that Elastic Transcoder adds to the bucket.
1591
- # Valid values include: READ: The grantee can read the thumbnails and
1592
- # metadata for objects that Elastic Transcoder adds to the Amazon S3
1593
- # bucket. READ_ACP: The grantee can read the object ACL for
1594
- # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
1595
- # WRITE_ACP: The grantee can write the ACL for the thumbnails that
1596
- # Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
1597
- # grantee has READ, READ_ACP, and WRITE_ACP permissions for the
1598
- # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
1599
- # StorageClass: The Amazon S3 storage class, Standard or
1600
- # ReducedRedundancy, that you want Elastic Transcoder to assign to
1601
- # the thumbnails that it stores in your Amazon S3 bucket.
1602
- # * `:bucket` - (String) The Amazon S3 bucket in which you want
1603
- # Elastic Transcoder to save the transcoded files. Specify this
1604
- # value when all of the following are `true` : You want to save
1605
- # transcoded files, thumbnails (if any), and playlists (if any)
1606
- # together in one bucket. You do not want to specify the users or
1607
- # groups who have access to the transcoded files, thumbnails, and
1608
- # playlists. You do not want to specify the permissions that
1609
- # Elastic Transcoder grants to the files. You want to associate the
1610
- # transcoded files and thumbnails with the Amazon S3 Standard
1611
- # storage class. If you want to save transcoded files and playlists
1612
- # in one bucket and thumbnails in another bucket, specify which
1613
- # users can access the transcoded files or the permissions the
1614
- # users have, or change the Amazon S3 storage class, omit
1615
- # OutputBucket and specify values for ContentConfig and
1616
- # ThumbnailConfig instead.
1617
- # * `:storage_class` - (String) The Amazon S3 storage class, Standard
1618
- # or ReducedRedundancy, that you want Elastic Transcoder to assign
1619
- # to the video files and playlists that it stores in your Amazon S3
1620
- # bucket.
1621
- # * `:permissions` - (Array<Hash>) Optional. The Permissions object
1622
- # specifies which users and/or predefined Amazon S3 groups you want
1623
- # to have access to transcoded files and playlists, and the type of
1624
- # access you want them to have. You can grant permissions to a
1625
- # maximum of 30 users and/or predefined Amazon S3 groups. If you
1626
- # include Permissions, Elastic Transcoder grants only the
1627
- # permissions that you specify. It does not grant full permissions
1628
- # to the owner of the role specified by Role. If you want that user
1629
- # to have full control, you must explicitly grant full control to
1630
- # the user. If you omit Permissions, Elastic Transcoder grants full
1631
- # control over the transcoded files and playlists to the owner of
1632
- # the role specified by Role, and grants no other permissions to
1633
- # any other user or group.
1634
- # * `:grantee_type` - (String) The type of value that appears in
1635
- # the Grantee object: Canonical: Either the canonical user ID for
1636
- # an AWS account or an origin access identity for an Amazon
1637
- # CloudFront distribution. A canonical user ID is not the same as
1638
- # an AWS account number. Email: The registered email address of
1639
- # an AWS account. Group: One of the following predefined Amazon
1640
- # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
1641
- # * `:grantee` - (String) The AWS user or group that you want to
1642
- # have access to transcoded files and playlists. To identify the
1643
- # user or group, you can specify the canonical user ID for an AWS
1644
- # account, an origin access identity for a CloudFront
1645
- # distribution, the registered email address of an AWS account,
1646
- # or a predefined Amazon S3 group.
1647
- # * `:access` - (Array<String>) The permission that you want to
1648
- # give to the AWS user that is listed in Grantee. Valid values
1649
- # include: READ: The grantee can read the thumbnails and metadata
1650
- # for thumbnails that Elastic Transcoder adds to the Amazon S3
1651
- # bucket. READ_ACP: The grantee can read the object ACL for
1652
- # thumbnails that Elastic Transcoder adds to the Amazon S3
1653
- # bucket. WRITE_ACP: The grantee can write the ACL for the
1654
- # thumbnails that Elastic Transcoder adds to the Amazon S3
1655
- # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
1656
- # WRITE_ACP permissions for the thumbnails that Elastic
1657
- # Transcoder adds to the Amazon S3 bucket.
1658
- # @return [Core::Response]
1659
- # The #data method of the response object returns
1660
- # a hash with the following structure:
1661
- #
1662
- # * `:pipeline` - (Hash)
1663
- # * `:id` - (String)
1664
- # * `:arn` - (String)
1665
- # * `:name` - (String)
1666
- # * `:status` - (String)
1667
- # * `:input_bucket` - (String)
1668
- # * `:output_bucket` - (String)
1669
- # * `:role` - (String)
1670
- # * `:notifications` - (Hash)
1671
- # * `:progressing` - (String)
1672
- # * `:completed` - (String)
1673
- # * `:warning` - (String)
1674
- # * `:error` - (String)
1675
- # * `:content_config` - (Hash)
1676
- # * `:bucket` - (String)
1677
- # * `:storage_class` - (String)
1678
- # * `:permissions` - (Array<Hash>)
1679
- # * `:grantee_type` - (String)
1680
- # * `:grantee` - (String)
1681
- # * `:access` - (Array<String>)
1682
- # * `:thumbnail_config` - (Hash)
1683
- # * `:bucket` - (String)
1684
- # * `:storage_class` - (String)
1685
- # * `:permissions` - (Array<Hash>)
1686
- # * `:grantee_type` - (String)
1687
- # * `:grantee` - (String)
1688
- # * `:access` - (Array<String>)
1689
-
1690
- # @!method update_pipeline_notifications(options = {})
1691
- # Calls the POST UpdatePipelineNotifications API operation.
1692
- # @param [Hash] options
1693
- #
1694
- # * `:id` - *required* - (String) The identifier of the pipeline for
1695
- # which you want to change notification settings.
1696
- # * `:notifications` - (Hash) The topic ARN for the Amazon Simple
1697
- # Notification Service (Amazon SNS) topic that you want to notify to
1698
- # report job status. To receive notifications, you must also
1699
- # subscribe to the new topic in the Amazon SNS console. Progressing:
1700
- # The topic ARN for the Amazon Simple Notification Service (Amazon
1701
- # SNS) topic that you want to notify when Elastic Transcoder has
1702
- # started to process jobs that are added to this pipeline. This is
1703
- # the ARN that Amazon SNS returned when you created the topic.
1704
- # Completed: The topic ARN for the Amazon SNS topic that you want to
1705
- # notify when Elastic Transcoder has finished processing a job. This
1706
- # is the ARN that Amazon SNS returned when you created the topic.
1707
- # Warning: The topic ARN for the Amazon SNS topic that you want to
1708
- # notify when Elastic Transcoder encounters a warning condition. This
1709
- # is the ARN that Amazon SNS returned when you created the topic.
1710
- # Error: The topic ARN for the Amazon SNS topic that you want to
1711
- # notify when Elastic Transcoder encounters an error condition. This
1712
- # is the ARN that Amazon SNS returned when you created the topic.
1713
- # * `:progressing` - (String) The Amazon Simple Notification Service
1714
- # (Amazon SNS) topic that you want to notify when Elastic
1715
- # Transcoder has started to process the job.
1716
- # * `:completed` - (String) The Amazon SNS topic that you want to
1717
- # notify when Elastic Transcoder has finished processing the job.
1718
- # * `:warning` - (String) The Amazon SNS topic that you want to
1719
- # notify when Elastic Transcoder encounters a warning condition.
1720
- # * `:error` - (String) The Amazon SNS topic that you want to notify
1721
- # when Elastic Transcoder encounters an error condition.
1722
- # @return [Core::Response]
1723
- # The #data method of the response object returns
1724
- # a hash with the following structure:
1725
- #
1726
- # * `:pipeline` - (Hash)
1727
- # * `:id` - (String)
1728
- # * `:arn` - (String)
1729
- # * `:name` - (String)
1730
- # * `:status` - (String)
1731
- # * `:input_bucket` - (String)
1732
- # * `:output_bucket` - (String)
1733
- # * `:role` - (String)
1734
- # * `:notifications` - (Hash)
1735
- # * `:progressing` - (String)
1736
- # * `:completed` - (String)
1737
- # * `:warning` - (String)
1738
- # * `:error` - (String)
1739
- # * `:content_config` - (Hash)
1740
- # * `:bucket` - (String)
1741
- # * `:storage_class` - (String)
1742
- # * `:permissions` - (Array<Hash>)
1743
- # * `:grantee_type` - (String)
1744
- # * `:grantee` - (String)
1745
- # * `:access` - (Array<String>)
1746
- # * `:thumbnail_config` - (Hash)
1747
- # * `:bucket` - (String)
1748
- # * `:storage_class` - (String)
1749
- # * `:permissions` - (Array<Hash>)
1750
- # * `:grantee_type` - (String)
1751
- # * `:grantee` - (String)
1752
- # * `:access` - (Array<String>)
1753
-
1754
- # @!method update_pipeline_status(options = {})
1755
- # Calls the POST UpdatePipelineStatus API operation.
1756
- # @param [Hash] options
1757
- #
1758
- # * `:id` - *required* - (String) The identifier of the pipeline to
1759
- # update.
1760
- # * `:status` - (String) The desired status of the pipeline: Active:
1761
- # The pipeline is processing jobs. Paused: The pipeline is not
1762
- # currently processing jobs.
1763
- # @return [Core::Response]
1764
- # The #data method of the response object returns
1765
- # a hash with the following structure:
1766
- #
1767
- # * `:pipeline` - (Hash)
1768
- # * `:id` - (String)
1769
- # * `:arn` - (String)
1770
- # * `:name` - (String)
1771
- # * `:status` - (String)
1772
- # * `:input_bucket` - (String)
1773
- # * `:output_bucket` - (String)
1774
- # * `:role` - (String)
1775
- # * `:notifications` - (Hash)
1776
- # * `:progressing` - (String)
1777
- # * `:completed` - (String)
1778
- # * `:warning` - (String)
1779
- # * `:error` - (String)
1780
- # * `:content_config` - (Hash)
1781
- # * `:bucket` - (String)
1782
- # * `:storage_class` - (String)
1783
- # * `:permissions` - (Array<Hash>)
1784
- # * `:grantee_type` - (String)
1785
- # * `:grantee` - (String)
1786
- # * `:access` - (Array<String>)
1787
- # * `:thumbnail_config` - (Hash)
1788
- # * `:bucket` - (String)
1789
- # * `:storage_class` - (String)
1790
- # * `:permissions` - (Array<Hash>)
1791
- # * `:grantee_type` - (String)
1792
- # * `:grantee` - (String)
1793
- # * `:access` - (Array<String>)
1794
-
1795
- # end client methods #
1796
-
1797
42
  define_client_methods('2012-09-25')
1798
43
 
1799
44
  end