aws-sdk 1.11.3 → 1.12.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.
@@ -22,6 +22,7 @@ module AWS
22
22
  # @!method batch_get_item(options = {})
23
23
  # Calls the BatchGetItem API operation.
24
24
  # @param [Hash] options
25
+ #
25
26
  # * `:request_items` - *required* - (Hash<String,Hash>) A map of one or
26
27
  # more table names and, for each table, the corresponding primary
27
28
  # keys for the items to retrieve. Each table name can be invoked only
@@ -50,7 +51,9 @@ module AWS
50
51
  # * `:consistent_read` - (Boolean) Represents the consistency of a
51
52
  # read operation. If set to `true` , then a strongly consistent
52
53
  # read is used; otherwise, an eventually consistent read is used.
53
- # * `:return_consumed_capacity` - (String)
54
+ # * `:return_consumed_capacity` - (String) Valid values include:
55
+ # * `TOTAL`
56
+ # * `NONE`
54
57
  # @return [Core::Response]
55
58
  # The #data method of the response object returns
56
59
  # a hash with the following structure:
@@ -80,6 +83,7 @@ module AWS
80
83
  # @!method batch_write_item(options = {})
81
84
  # Calls the BatchWriteItem API operation.
82
85
  # @param [Hash] options
86
+ #
83
87
  # * `:request_items` - *required* - (Hash<String,Array<Hash>>) A map of
84
88
  # one or more table names and, for each table, a list of operations
85
89
  # to be performed (DeleteRequest or PutRequest). Each element in the
@@ -126,8 +130,12 @@ module AWS
126
130
  # * `:ss` - (Array<String>) Represents a String set data type
127
131
  # * `:ns` - (Array<String>) Represents a Number set data type
128
132
  # * `:bs` - (Array<String>) Represents a Binary set data type
129
- # * `:return_consumed_capacity` - (String)
130
- # * `:return_item_collection_metrics` - (String)
133
+ # * `:return_consumed_capacity` - (String) Valid values include:
134
+ # * `TOTAL`
135
+ # * `NONE`
136
+ # * `:return_item_collection_metrics` - (String) Valid values include:
137
+ # * `SIZE`
138
+ # * `NONE`
131
139
  # @return [Core::Response]
132
140
  # The #data method of the response object returns
133
141
  # a hash with the following structure:
@@ -167,12 +175,16 @@ module AWS
167
175
  # @!method create_table(options = {})
168
176
  # Calls the CreateTable API operation.
169
177
  # @param [Hash] options
178
+ #
170
179
  # * `:attribute_definitions` - *required* - (Array<Hash>) An array of
171
180
  # attributes that describe the key schema for the table and indexes.
172
181
  # * `:attribute_name` - *required* - (String) A name for the
173
182
  # attribute.
174
183
  # * `:attribute_type` - *required* - (String) The data type for the
175
- # attribute.
184
+ # attribute. Valid values include:
185
+ # * `S`
186
+ # * `N`
187
+ # * `B`
176
188
  # * `:table_name` - *required* - (String) The name of the table to
177
189
  # create.
178
190
  # * `:key_schema` - *required* - (Array<Hash>) Specifies the attributes
@@ -191,6 +203,9 @@ module AWS
191
203
  # a key attribute.
192
204
  # * `:key_type` - *required* - (String) Represents the attribute
193
205
  # data, consisting of the data type and the attribute value itself.
206
+ # Valid values include:
207
+ # * `HASH`
208
+ # * `RANGE`
194
209
  # * `:local_secondary_indexes` - (Array<Hash>) One or more secondary
195
210
  # indexes (the maximum is five) to be created on the table. Each
196
211
  # index is scoped to a given hash key value. There is a 10 gigabyte
@@ -210,14 +225,20 @@ module AWS
210
225
  # of a key attribute.
211
226
  # * `:key_type` - *required* - (String) Represents the attribute
212
227
  # data, consisting of the data type and the attribute value
213
- # itself.
228
+ # itself. Valid values include:
229
+ # * `HASH`
230
+ # * `RANGE`
214
231
  # * `:projection` - *required* - (Hash)
215
232
  # * `:projection_type` - (String) Represents the set of attributes
216
233
  # that are projected into the index: KEYS_ONLY - Only the index
217
234
  # and primary keys are projected into the index. INCLUDE - Only
218
235
  # the specified table attributes are projected into the index.
219
236
  # The list of projected attributes are in NonKeyAttributes. ALL -
220
- # All of the table attributes are projected into the index.
237
+ # All of the table attributes are projected into the index. Valid
238
+ # values include:
239
+ # * `ALL`
240
+ # * `KEYS_ONLY`
241
+ # * `INCLUDE`
221
242
  # * `:non_key_attributes` - (Array<String>) Represents the non-key
222
243
  # attribute names which will be projected into the index. The
223
244
  # total count of attributes specified in NonKeyAttributes, summed
@@ -270,6 +291,7 @@ module AWS
270
291
  # @!method delete_item(options = {})
271
292
  # Calls the DeleteItem API operation.
272
293
  # @param [Hash] options
294
+ #
273
295
  # * `:table_name` - *required* - (String) The name of the table from
274
296
  # which to delete the item.
275
297
  # * `:key` - *required* - (Hash<String,Hash>) A map of attribute names
@@ -318,9 +340,18 @@ module AWS
318
340
  # DeleteItem, the valid values are: NONE - If ReturnValues is not
319
341
  # specified, or if its value is NONE, then nothing is returned. (This
320
342
  # is the default for ReturnValues.) ALL_OLD - The content of the old
321
- # item is returned.
322
- # * `:return_consumed_capacity` - (String)
323
- # * `:return_item_collection_metrics` - (String)
343
+ # item is returned. Valid values include:
344
+ # * `NONE`
345
+ # * `ALL_OLD`
346
+ # * `UPDATED_OLD`
347
+ # * `ALL_NEW`
348
+ # * `UPDATED_NEW`
349
+ # * `:return_consumed_capacity` - (String) Valid values include:
350
+ # * `TOTAL`
351
+ # * `NONE`
352
+ # * `:return_item_collection_metrics` - (String) Valid values include:
353
+ # * `SIZE`
354
+ # * `NONE`
324
355
  # @return [Core::Response]
325
356
  # The #data method of the response object returns
326
357
  # a hash with the following structure:
@@ -348,6 +379,7 @@ module AWS
348
379
  # @!method delete_table(options = {})
349
380
  # Calls the DeleteTable API operation.
350
381
  # @param [Hash] options
382
+ #
351
383
  # * `:table_name` - *required* - (String) The name of the table to
352
384
  # delete.
353
385
  # @return [Core::Response]
@@ -386,6 +418,7 @@ module AWS
386
418
  # @!method describe_table(options = {})
387
419
  # Calls the DescribeTable API operation.
388
420
  # @param [Hash] options
421
+ #
389
422
  # * `:table_name` - *required* - (String) The name of the table to
390
423
  # describe.
391
424
  # @return [Core::Response]
@@ -424,6 +457,7 @@ module AWS
424
457
  # @!method get_item(options = {})
425
458
  # Calls the GetItem API operation.
426
459
  # @param [Hash] options
460
+ #
427
461
  # * `:table_name` - *required* - (String) The name of the table
428
462
  # containing the requested item.
429
463
  # * `:key` - *required* - (Hash<String,Hash>) A map of attribute names
@@ -437,7 +471,9 @@ module AWS
437
471
  # * `:bs` - (Array<String>) Represents a Binary set data type
438
472
  # * `:attributes_to_get` - (Array<String>)
439
473
  # * `:consistent_read` - (Boolean)
440
- # * `:return_consumed_capacity` - (String)
474
+ # * `:return_consumed_capacity` - (String) Valid values include:
475
+ # * `TOTAL`
476
+ # * `NONE`
441
477
  # @return [Core::Response]
442
478
  # The #data method of the response object returns
443
479
  # a hash with the following structure:
@@ -456,6 +492,7 @@ module AWS
456
492
  # @!method list_tables(options = {})
457
493
  # Calls the ListTables API operation.
458
494
  # @param [Hash] options
495
+ #
459
496
  # * `:exclusive_start_table_name` - (String) The name of the table that
460
497
  # starts the list. If you already ran a ListTables operation and
461
498
  # received a LastEvaluatedTableName value in the response, use that
@@ -471,6 +508,7 @@ module AWS
471
508
  # @!method put_item(options = {})
472
509
  # Calls the PutItem API operation.
473
510
  # @param [Hash] options
511
+ #
474
512
  # * `:table_name` - *required* - (String) The name of the table to
475
513
  # contain the item.
476
514
  # * `:item` - *required* - (Hash<String,Hash>) A map of attribute
@@ -525,9 +563,18 @@ module AWS
525
563
  # ReturnValues is not specified, or if its value is NONE, then
526
564
  # nothing is returned. (This is the default for ReturnValues.)
527
565
  # ALL_OLD - If PutItem overwrote an attribute name-value pair, then
528
- # the content of the old item is returned.
529
- # * `:return_consumed_capacity` - (String)
530
- # * `:return_item_collection_metrics` - (String)
566
+ # the content of the old item is returned. Valid values include:
567
+ # * `NONE`
568
+ # * `ALL_OLD`
569
+ # * `UPDATED_OLD`
570
+ # * `ALL_NEW`
571
+ # * `UPDATED_NEW`
572
+ # * `:return_consumed_capacity` - (String) Valid values include:
573
+ # * `TOTAL`
574
+ # * `NONE`
575
+ # * `:return_item_collection_metrics` - (String) Valid values include:
576
+ # * `SIZE`
577
+ # * `NONE`
531
578
  # @return [Core::Response]
532
579
  # The #data method of the response object returns
533
580
  # a hash with the following structure:
@@ -555,6 +602,7 @@ module AWS
555
602
  # @!method query(options = {})
556
603
  # Calls the Query API operation.
557
604
  # @param [Hash] options
605
+ #
558
606
  # * `:table_name` - *required* - (String) The name of the table
559
607
  # containing the requested items.
560
608
  # * `:index_name` - (String) The name of an index on the table to
@@ -581,7 +629,12 @@ module AWS
581
629
  # when accessing an index. You cannot use both Select and
582
630
  # AttributesToGet together in a single request, unless the value for
583
631
  # Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
584
- # specifying AttributesToGet without any value for Select.)
632
+ # specifying AttributesToGet without any value for Select.) Valid
633
+ # values include:
634
+ # * `ALL_ATTRIBUTES`
635
+ # * `ALL_PROJECTED_ATTRIBUTES`
636
+ # * `SPECIFIC_ATTRIBUTES`
637
+ # * `COUNT`
585
638
  # * `:attributes_to_get` - (Array<String>) You cannot use both
586
639
  # AttributesToGet and Select together in a Query request, unless the
587
640
  # value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent
@@ -748,7 +801,20 @@ module AWS
748
801
  # different type than the one specified in the request, the value
749
802
  # does not match. For example, {"S":"6"} does not compare to
750
803
  # {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
751
- # "1"]}
804
+ # "1"]} Valid values include:
805
+ # * `EQ`
806
+ # * `NE`
807
+ # * `IN`
808
+ # * `LE`
809
+ # * `LT`
810
+ # * `GE`
811
+ # * `GT`
812
+ # * `BETWEEN`
813
+ # * `NOT_NULL`
814
+ # * `NULL`
815
+ # * `CONTAINS`
816
+ # * `NOT_CONTAINS`
817
+ # * `BEGINS_WITH`
752
818
  # * `:scan_index_forward` - (Boolean) Specifies ascending ( `true` ) or
753
819
  # descending ( `false` ) traversal of the index. returns results
754
820
  # reflecting the requested order determined by the range key. If the
@@ -765,7 +831,9 @@ module AWS
765
831
  # * `:ss` - (Array<String>) Represents a String set data type
766
832
  # * `:ns` - (Array<String>) Represents a Number set data type
767
833
  # * `:bs` - (Array<String>) Represents a Binary set data type
768
- # * `:return_consumed_capacity` - (String)
834
+ # * `:return_consumed_capacity` - (String) Valid values include:
835
+ # * `TOTAL`
836
+ # * `NONE`
769
837
  # @return [Core::Response]
770
838
  # The #data method of the response object returns
771
839
  # a hash with the following structure:
@@ -792,6 +860,7 @@ module AWS
792
860
  # @!method scan(options = {})
793
861
  # Calls the Scan API operation.
794
862
  # @param [Hash] options
863
+ #
795
864
  # * `:table_name` - *required* - (String) The name of the table
796
865
  # containing the requested items.
797
866
  # * `:attributes_to_get` - (Array<String>)
@@ -818,7 +887,11 @@ module AWS
818
887
  # index. You cannot use both Select and AttributesToGet together in a
819
888
  # single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
820
889
  # (This usage is equivalent to specifying AttributesToGet without any
821
- # value for Select.)
890
+ # value for Select.) Valid values include:
891
+ # * `ALL_ATTRIBUTES`
892
+ # * `ALL_PROJECTED_ATTRIBUTES`
893
+ # * `SPECIFIC_ATTRIBUTES`
894
+ # * `COUNT`
822
895
  # * `:scan_filter` - (Hash<String,Hash>) Evaluates the scan results and
823
896
  # returns only the desired values. Multiple conditions are treated as
824
897
  # "AND" operations: all conditions must be met to be included in the
@@ -1000,7 +1073,20 @@ module AWS
1000
1073
  # different type than the one specified in the request, the value
1001
1074
  # does not match. For example, {"S":"6"} does not compare to
1002
1075
  # {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
1003
- # "1"]}
1076
+ # "1"]} Valid values include:
1077
+ # * `EQ`
1078
+ # * `NE`
1079
+ # * `IN`
1080
+ # * `LE`
1081
+ # * `LT`
1082
+ # * `GE`
1083
+ # * `GT`
1084
+ # * `BETWEEN`
1085
+ # * `NOT_NULL`
1086
+ # * `NULL`
1087
+ # * `CONTAINS`
1088
+ # * `NOT_CONTAINS`
1089
+ # * `BEGINS_WITH`
1004
1090
  # * `:exclusive_start_key` - (Hash<String,Hash>) In a parallel scan, a
1005
1091
  # Scan request that includes ExclusiveStartKey must specify the same
1006
1092
  # segment whose previous Scan returned the corresponding value of
@@ -1011,7 +1097,9 @@ module AWS
1011
1097
  # * `:ss` - (Array<String>) Represents a String set data type
1012
1098
  # * `:ns` - (Array<String>) Represents a Number set data type
1013
1099
  # * `:bs` - (Array<String>) Represents a Binary set data type
1014
- # * `:return_consumed_capacity` - (String)
1100
+ # * `:return_consumed_capacity` - (String) Valid values include:
1101
+ # * `TOTAL`
1102
+ # * `NONE`
1015
1103
  # * `:total_segments` - (Integer) For a parallel Scan request,
1016
1104
  # TotalSegments represents the total number of segments into which
1017
1105
  # the Scan operation will be divided. The value of TotalSegments
@@ -1060,6 +1148,7 @@ module AWS
1060
1148
  # @!method update_item(options = {})
1061
1149
  # Calls the UpdateItem API operation.
1062
1150
  # @param [Hash] options
1151
+ #
1063
1152
  # * `:table_name` - *required* - (String) The name of the table
1064
1153
  # containing the item to update.
1065
1154
  # * `:key` - *required* - (Hash<String,Hash>) The primary key that
@@ -1187,7 +1276,10 @@ module AWS
1187
1276
  # delete. ADD - creates an item with the supplied primary key and
1188
1277
  # number (or set of numbers) for the attribute value. The only data
1189
1278
  # types allowed are number and number set; no other data types can
1190
- # be specified.
1279
+ # be specified. Valid values include:
1280
+ # * `ADD`
1281
+ # * `PUT`
1282
+ # * `DELETE`
1191
1283
  # * `:expected` - (Hash<String,Hash>) A map of attribute/condition
1192
1284
  # pairs. This is the conditional block for the UpdateItem operation.
1193
1285
  # All the conditions must be met for the operation to succeed.
@@ -1230,9 +1322,18 @@ module AWS
1230
1322
  # versions of only the updated attributes are returned. ALL_NEW - All
1231
1323
  # of the attributes of the new version of the item are returned.
1232
1324
  # UPDATED_NEW - The new versions of only the updated attributes are
1233
- # returned.
1234
- # * `:return_consumed_capacity` - (String)
1235
- # * `:return_item_collection_metrics` - (String)
1325
+ # returned. Valid values include:
1326
+ # * `NONE`
1327
+ # * `ALL_OLD`
1328
+ # * `UPDATED_OLD`
1329
+ # * `ALL_NEW`
1330
+ # * `UPDATED_NEW`
1331
+ # * `:return_consumed_capacity` - (String) Valid values include:
1332
+ # * `TOTAL`
1333
+ # * `NONE`
1334
+ # * `:return_item_collection_metrics` - (String) Valid values include:
1335
+ # * `SIZE`
1336
+ # * `NONE`
1236
1337
  # @return [Core::Response]
1237
1338
  # The #data method of the response object returns
1238
1339
  # a hash with the following structure:
@@ -1260,6 +1361,7 @@ module AWS
1260
1361
  # @!method update_table(options = {})
1261
1362
  # Calls the UpdateTable API operation.
1262
1363
  # @param [Hash] options
1364
+ #
1263
1365
  # * `:table_name` - *required* - (String) The name of the table to be
1264
1366
  # updated.
1265
1367
  # * `:provisioned_throughput` - *required* - (Hash)
@@ -40,7 +40,7 @@ module AWS
40
40
  # @param [Hash] options
41
41
  #
42
42
  # * `:id` - *required* - (String) The identifier of the job that you
43
- # want to delete. To get a list of the jobs (including their jobId)
43
+ # want to cancel. To get a list of the jobs (including their jobId)
44
44
  # that have a status of Submitted, use the ListJobsByStatus API
45
45
  # action.
46
46
  # @return [Core::Response]
@@ -136,6 +136,25 @@ module AWS
136
136
  # PresetId for which the value of Container is ts (MPEG-TS),
137
137
  # SegmentDuration is the duration of each .ts file in seconds. The
138
138
  # range of valid values is 1 to 60 seconds.
139
+ # * `:watermarks` - (Array<Hash>) Information about the watermarks
140
+ # that you want Elastic Transcoder to add to the video during
141
+ # transcoding. You can specify up to four watermarks for each
142
+ # output. Settings for each watermark must be defined in the preset
143
+ # for the current output.
144
+ # * `:preset_watermark_id` - (String) The ID of the watermark
145
+ # settings that Elastic Transcoder uses to add watermarks to the
146
+ # video during transcoding. The settings are in the preset
147
+ # specified by Preset for the current output. In that preset, the
148
+ # value of Watermarks Id tells Elastic Transcoder which settings
149
+ # to use.
150
+ # * `:input_key` - (String) The name of the .png or .jpg file that
151
+ # you want to use for the watermark. To determine which Amazon S3
152
+ # bucket contains the specified file, Elastic Transcoder checks
153
+ # the pipeline specified by Pipeline; the Input Bucket object in
154
+ # that pipeline identifies the bucket. If the file name includes
155
+ # a prefix, for example, logos/128x64.png, include the prefix in
156
+ # the key. If the file isn't in the specified bucket, Elastic
157
+ # Transcoder returns an error.
139
158
  # * `:outputs` - (Array<Hash>) A section of the request body that
140
159
  # provides information about the transcoded (target) files. We
141
160
  # recommend that you use the Outputs syntax instead of the Output
@@ -182,6 +201,25 @@ module AWS
182
201
  # PresetId for which the value of Container is ts (MPEG-TS),
183
202
  # SegmentDuration is the duration of each .ts file in seconds. The
184
203
  # range of valid values is 1 to 60 seconds.
204
+ # * `:watermarks` - (Array<Hash>) Information about the watermarks
205
+ # that you want Elastic Transcoder to add to the video during
206
+ # transcoding. You can specify up to four watermarks for each
207
+ # output. Settings for each watermark must be defined in the preset
208
+ # for the current output.
209
+ # * `:preset_watermark_id` - (String) The ID of the watermark
210
+ # settings that Elastic Transcoder uses to add watermarks to the
211
+ # video during transcoding. The settings are in the preset
212
+ # specified by Preset for the current output. In that preset, the
213
+ # value of Watermarks Id tells Elastic Transcoder which settings
214
+ # to use.
215
+ # * `:input_key` - (String) The name of the .png or .jpg file that
216
+ # you want to use for the watermark. To determine which Amazon S3
217
+ # bucket contains the specified file, Elastic Transcoder checks
218
+ # the pipeline specified by Pipeline; the Input Bucket object in
219
+ # that pipeline identifies the bucket. If the file name includes
220
+ # a prefix, for example, logos/128x64.png, include the prefix in
221
+ # the key. If the file isn't in the specified bucket, Elastic
222
+ # Transcoder returns an error.
185
223
  # * `:output_key_prefix` - (String) The value, if any, that you want
186
224
  # Elastic Transcoder to prepend to the names of all files that this
187
225
  # job creates, including output files, thumbnails, and playlists.
@@ -230,6 +268,9 @@ module AWS
230
268
  # * `:duration` - (Integer)
231
269
  # * `:width` - (Integer)
232
270
  # * `:height` - (Integer)
271
+ # * `:watermarks` - (Array<Hash>)
272
+ # * `:preset_watermark_id` - (String)
273
+ # * `:input_key` - (String)
233
274
  # * `:outputs` - (Array<Hash>)
234
275
  # * `:id` - (String)
235
276
  # * `:key` - (String)
@@ -242,6 +283,9 @@ module AWS
242
283
  # * `:duration` - (Integer)
243
284
  # * `:width` - (Integer)
244
285
  # * `:height` - (Integer)
286
+ # * `:watermarks` - (Array<Hash>)
287
+ # * `:preset_watermark_id` - (String)
288
+ # * `:input_key` - (String)
245
289
  # * `:output_key_prefix` - (String)
246
290
  # * `:playlists` - (Array<Hash>)
247
291
  # * `:name` - (String)
@@ -356,12 +400,62 @@ module AWS
356
400
  # Amazon S3 storage class, Standard or ReducedRedundancy, that you
357
401
  # want Elastic Transcoder to assign to the video files and playlists
358
402
  # that it stores in your Amazon S3 bucket.
359
- # * `:bucket` - (String)
360
- # * `:storage_class` - (String)
361
- # * `:permissions` - (Array<Hash>)
362
- # * `:grantee_type` - (String)
363
- # * `:grantee` - (String)
364
- # * `:access` - (Array<String>)
403
+ # * `:bucket` - (String) The Amazon S3 bucket in which you want
404
+ # Elastic Transcoder to save the transcoded files. Specify this
405
+ # value when all of the following are `true` : You want to save
406
+ # transcoded files, thumbnails (if any), and playlists (if any)
407
+ # together in one bucket. You do not want to specify the users or
408
+ # groups who have access to the transcoded files, thumbnails, and
409
+ # playlists. You do not want to specify the permissions that
410
+ # Elastic Transcoder grants to the files. You want to associate the
411
+ # transcoded files and thumbnails with the Amazon S3 Standard
412
+ # storage class. If you want to save transcoded files and playlists
413
+ # in one bucket and thumbnails in another bucket, specify which
414
+ # users can access the transcoded files or the permissions the
415
+ # users have, or change the Amazon S3 storage class, omit
416
+ # OutputBucket and specify values for ContentConfig and
417
+ # ThumbnailConfig instead.
418
+ # * `:storage_class` - (String) The Amazon S3 storage class, Standard
419
+ # or ReducedRedundancy, that you want Elastic Transcoder to assign
420
+ # to the video files and playlists that it stores in your Amazon S3
421
+ # bucket.
422
+ # * `:permissions` - (Array<Hash>) Optional. The Permissions object
423
+ # specifies which users and/or predefined Amazon S3 groups you want
424
+ # to have access to transcoded files and playlists, and the type of
425
+ # access you want them to have. You can grant permissions to a
426
+ # maximum of 30 users and/or predefined Amazon S3 groups. If you
427
+ # include Permissions, Elastic Transcoder grants only the
428
+ # permissions that you specify. It does not grant full permissions
429
+ # to the owner of the role specified by Role. If you want that user
430
+ # to have full control, you must explicitly grant full control to
431
+ # the user. If you omit Permissions, Elastic Transcoder grants full
432
+ # control over the transcoded files and playlists to the owner of
433
+ # the role specified by Role, and grants no other permissions to
434
+ # any other user or group.
435
+ # * `:grantee_type` - (String) The type of value that appears in
436
+ # the Grantee object: Canonical: Either the canonical user ID for
437
+ # an AWS account or an origin access identity for an Amazon
438
+ # CloudFront distribution. A canonical user ID is not the same as
439
+ # an AWS account number. Email: The registered email address of
440
+ # an AWS account. Group: One of the following predefined Amazon
441
+ # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
442
+ # * `:grantee` - (String) The AWS user or group that you want to
443
+ # have access to transcoded files and playlists. To identify the
444
+ # user or group, you can specify the canonical user ID for an AWS
445
+ # account, an origin access identity for a CloudFront
446
+ # distribution, the registered email address of an AWS account,
447
+ # or a predefined Amazon S3 group.
448
+ # * `:access` - (Array<String>) The permission that you want to
449
+ # give to the AWS user that is listed in Grantee. Valid values
450
+ # include: READ: The grantee can read the thumbnails and metadata
451
+ # for thumbnails that Elastic Transcoder adds to the Amazon S3
452
+ # bucket. READ_ACP: The grantee can read the object ACL for
453
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
454
+ # bucket. WRITE_ACP: The grantee can write the ACL for the
455
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
456
+ # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
457
+ # WRITE_ACP permissions for the thumbnails that Elastic
458
+ # Transcoder adds to the Amazon S3 bucket.
365
459
  # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
366
460
  # several values, including the Amazon S3 bucket in which you want
367
461
  # Elastic Transcoder to save thumbnail files, which users you want to
@@ -403,12 +497,62 @@ module AWS
403
497
  # StorageClass: The Amazon S3 storage class, Standard or
404
498
  # ReducedRedundancy, that you want Elastic Transcoder to assign to
405
499
  # the thumbnails that it stores in your Amazon S3 bucket.
406
- # * `:bucket` - (String)
407
- # * `:storage_class` - (String)
408
- # * `:permissions` - (Array<Hash>)
409
- # * `:grantee_type` - (String)
410
- # * `:grantee` - (String)
411
- # * `:access` - (Array<String>)
500
+ # * `:bucket` - (String) The Amazon S3 bucket in which you want
501
+ # Elastic Transcoder to save the transcoded files. Specify this
502
+ # value when all of the following are `true` : You want to save
503
+ # transcoded files, thumbnails (if any), and playlists (if any)
504
+ # together in one bucket. You do not want to specify the users or
505
+ # groups who have access to the transcoded files, thumbnails, and
506
+ # playlists. You do not want to specify the permissions that
507
+ # Elastic Transcoder grants to the files. You want to associate the
508
+ # transcoded files and thumbnails with the Amazon S3 Standard
509
+ # storage class. If you want to save transcoded files and playlists
510
+ # in one bucket and thumbnails in another bucket, specify which
511
+ # users can access the transcoded files or the permissions the
512
+ # users have, or change the Amazon S3 storage class, omit
513
+ # OutputBucket and specify values for ContentConfig and
514
+ # ThumbnailConfig instead.
515
+ # * `:storage_class` - (String) The Amazon S3 storage class, Standard
516
+ # or ReducedRedundancy, that you want Elastic Transcoder to assign
517
+ # to the video files and playlists that it stores in your Amazon S3
518
+ # bucket.
519
+ # * `:permissions` - (Array<Hash>) Optional. The Permissions object
520
+ # specifies which users and/or predefined Amazon S3 groups you want
521
+ # to have access to transcoded files and playlists, and the type of
522
+ # access you want them to have. You can grant permissions to a
523
+ # maximum of 30 users and/or predefined Amazon S3 groups. If you
524
+ # include Permissions, Elastic Transcoder grants only the
525
+ # permissions that you specify. It does not grant full permissions
526
+ # to the owner of the role specified by Role. If you want that user
527
+ # to have full control, you must explicitly grant full control to
528
+ # the user. If you omit Permissions, Elastic Transcoder grants full
529
+ # control over the transcoded files and playlists to the owner of
530
+ # the role specified by Role, and grants no other permissions to
531
+ # any other user or group.
532
+ # * `:grantee_type` - (String) The type of value that appears in
533
+ # the Grantee object: Canonical: Either the canonical user ID for
534
+ # an AWS account or an origin access identity for an Amazon
535
+ # CloudFront distribution. A canonical user ID is not the same as
536
+ # an AWS account number. Email: The registered email address of
537
+ # an AWS account. Group: One of the following predefined Amazon
538
+ # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
539
+ # * `:grantee` - (String) The AWS user or group that you want to
540
+ # have access to transcoded files and playlists. To identify the
541
+ # user or group, you can specify the canonical user ID for an AWS
542
+ # account, an origin access identity for a CloudFront
543
+ # distribution, the registered email address of an AWS account,
544
+ # or a predefined Amazon S3 group.
545
+ # * `:access` - (Array<String>) The permission that you want to
546
+ # give to the AWS user that is listed in Grantee. Valid values
547
+ # include: READ: The grantee can read the thumbnails and metadata
548
+ # for thumbnails that Elastic Transcoder adds to the Amazon S3
549
+ # bucket. READ_ACP: The grantee can read the object ACL for
550
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
551
+ # bucket. WRITE_ACP: The grantee can write the ACL for the
552
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
553
+ # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
554
+ # WRITE_ACP permissions for the thumbnails that Elastic
555
+ # Transcoder adds to the Amazon S3 bucket.
412
556
  # @return [Core::Response]
413
557
  # The #data method of the response object returns
414
558
  # a hash with the following structure:
@@ -462,33 +606,40 @@ module AWS
462
606
  # videoconferencing and for mobile applications. main: The profile
463
607
  # used for standard-definition digital TV broadcasts. high: The
464
608
  # profile used for high-definition digital TV broadcasts and for
465
- # Blu-ray discs. Level The H.264 level that you want to use for the
466
- # output file. Elastic Transcoder supports the following levels: 1,
467
- # 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1
468
- # MaxReferenceFrames The maximum number of previously decoded
469
- # frames to use as a reference for decoding future frames. Valid
470
- # values are integers 0 through 16, but we recommend that you not
471
- # use a value greater than the following: Min(Floor(Maximum decoded
472
- # picture buffer in macroblocks * 256 / (Width in pixels * Height
473
- # in pixels)), 16) where Width in pixels and Height in pixels
474
- # represent the resolution of the output video and Maximum decoded
475
- # picture buffer in macroblocks depends on the value of the Level
476
- # object. (A macroblock is a block of pixels measuring 16x16.) Note
477
- # that the calculation for maximum decoded picture buffer, which is
478
- # similar to the calculation for maximum reference frames, uses
479
- # macroblocks instead of pixels for the width and height of the
480
- # video. To determine the value of maximum decoded picture buffer
481
- # in macroblocks, see the following list (Level - Maximum decoded
482
- # picture buffer): 1 - 396 1b - 396 1.1 - 900 1.2 - 2376 1.3 - 2376
483
- # 2 - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 - 18000 3.2 - 20480 4
484
- # - 32768 4.1 - 32768
609
+ # Blu-ray discs. Level (H.264 Only) The H.264 level that you want
610
+ # to use for the output file. Elastic Transcoder supports the
611
+ # following levels: 1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2,
612
+ # 4, 4.1 MaxReferenceFrames (H.264 Only) Applicable only when the
613
+ # value of Video:Codec is H.264. The maximum number of previously
614
+ # decoded frames to use as a reference for decoding future frames.
615
+ # Valid values are integers 0 through 16, but we recommend that you
616
+ # not use a value greater than the following: Min(Floor(Maximum
617
+ # decoded picture buffer in macroblocks * 256 / (Width in pixels *
618
+ # Height in pixels)), 16) where Width in pixels and Height in
619
+ # pixels represent either MaxWidth and MaxHeight, or Resolution.
620
+ # Maximum decoded picture buffer in macroblocks depends on the
621
+ # value of the Level object. See the list below. (A macroblock is a
622
+ # block of pixels measuring 16x16.) 1 - 396 1b - 396 1.1 - 900 1.2
623
+ # - 2376 1.3 - 2376 2 - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 -
624
+ # 18000 3.2 - 20480 4 - 32768 4.1 - 32768 MaxBitRate The maximum
625
+ # number of bits per second in a video buffer; the size of the
626
+ # buffer is specified by BufferSize. Specify a value between 16 and
627
+ # 62,500. You can reduce the bandwidth required to stream a video
628
+ # by reducing the maximum bit rate, but this also reduces the
629
+ # quality of the video. BufferSize The maximum number of bits in
630
+ # any x seconds of the output video. This window is commonly 10
631
+ # seconds, the standard segment duration when you’re using MPEG-TS
632
+ # for the container type of the output video. Specify an integer
633
+ # greater than 0. If you specify MaxBitRate and omit BufferSize,
634
+ # Elastic Transcoder sets BufferSize to 10 times the value of
635
+ # MaxBitRate.
485
636
  # * `:keyframes_max_dist` - (String) The maximum number of frames
486
637
  # between key frames. Key frames are fully encoded frames; the
487
638
  # frames between key frames are encoded based, in part, on the
488
639
  # content of the key frames. The value is an integer formatted as a
489
- # string; valid values are between 1 and 100000, inclusive. A
490
- # higher value results in higher compression but may also
491
- # discernibly decrease video quality.
640
+ # string; valid values are between 1 (every frame is a key frame)
641
+ # and 100000, inclusive. A higher value results in higher
642
+ # compression but may also discernibly decrease video quality.
492
643
  # * `:fixed_gop` - (String) Whether to use a fixed value for
493
644
  # FixedGOP. Valid values are `true` and `false` : `true` : Elastic
494
645
  # Transcoder uses the value of KeyframesMaxDist for the distance
@@ -523,6 +674,13 @@ module AWS
523
674
  # 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 -
524
675
  # 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560
525
676
  # 4.1 - 62914560
677
+ # * `:max_frame_rate` - (String) If you specify auto for FrameRate,
678
+ # Elastic Transcoder uses the frame rate of the input video for the
679
+ # frame rate of the output video. Specify the maximum frame rate
680
+ # that you want Elastic Transcoder to use when the frame rate of
681
+ # the input video is greater than the desired maximum frame rate of
682
+ # the output video. Valid values include: 10, 15, 23.97, 24, 25,
683
+ # 29.97, 30, 60.
526
684
  # * `:resolution` - (String) To better control resolution and aspect
527
685
  # ratio of output videos, we recommend that you use the values
528
686
  # MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
@@ -600,6 +758,125 @@ module AWS
600
758
  # and/or left and right sides of the output video to make the total
601
759
  # size of the output video match the values that you specified for
602
760
  # MaxWidth and MaxHeight.
761
+ # * `:watermarks` - (Array<Hash>) Settings for the size, location,
762
+ # and opacity of graphics that you want Elastic Transcoder to
763
+ # overlay over videos that are transcoded using this preset. You
764
+ # can specify settings for up to four watermarks. Watermarks appear
765
+ # in the specified size and location, and with the specified
766
+ # opacity for the duration of the transcoded video. Watermarks can
767
+ # be in .png or .jpg format. If you want to display a watermark
768
+ # that is not rectangular, use the .png format, which supports
769
+ # transparency. When you create a job that uses this preset, you
770
+ # specify the .png or .jpg graphics that you want Elastic
771
+ # Transcoder to include in the transcoded videos. You can specify
772
+ # fewer graphics in the job than you specify watermark settings in
773
+ # the preset, which allows you to use the same preset for up to
774
+ # four watermarks that have different dimensions.
775
+ # * `:id` - (String) A unique identifier for the settings for one
776
+ # watermark. The value of Id can be up to 40 characters long.
777
+ # * `:max_width` - (String) The maximum width of the watermark in
778
+ # one of the following formats: number of pixels (px): The
779
+ # minimum value is 16 pixels, and the maximum value is the value
780
+ # of MaxWidth. integer percentage (%): The range of valid values
781
+ # is 0 to 100. Use the value of Target to specify whether you
782
+ # want Elastic Transcoder to include the black bars that are
783
+ # added by Elastic Transcoder, if any, in the calculation. If you
784
+ # specify the value in pixels, it must be less than or equal to
785
+ # the value of MaxWidth.
786
+ # * `:max_height` - (String) The maximum height of the watermark in
787
+ # one of the following formats: number of pixels (px): The
788
+ # minimum value is 16 pixels, and the maximum value is the value
789
+ # of MaxHeight. integer percentage (%): The range of valid values
790
+ # is 0 to 100. Use the value of Target to specify whether you
791
+ # want Elastic Transcoder to include the black bars that are
792
+ # added by Elastic Transcoder, if any, in the calculation. If you
793
+ # specify the value in pixels, it must be less than or equal to
794
+ # the value of MaxHeight.
795
+ # * `:sizing_policy` - (String) A value that controls scaling of
796
+ # the watermark: Fit: Elastic Transcoder scales the watermark so
797
+ # it matches the value that you specified in either MaxWidth or
798
+ # MaxHeight without exceeding the other value. Stretch: Elastic
799
+ # Transcoder stretches the watermark to match the values that you
800
+ # specified for MaxWidth and MaxHeight. If the relative
801
+ # proportions of the watermark and the values of MaxWidth and
802
+ # MaxHeight are different, the watermark will be distorted.
803
+ # ShrinkToFit: Elastic Transcoder scales the watermark down so
804
+ # that its dimensions match the values that you specified for at
805
+ # least one of MaxWidth and MaxHeight without exceeding either
806
+ # value. If you specify this option, Elastic Transcoder does not
807
+ # scale the watermark up.
808
+ # * `:horizontal_align` - (String) The horizontal position of the
809
+ # watermark unless you specify a non-zero value for
810
+ # HorizontalOffset: Left: The left edge of the watermark is
811
+ # aligned with the left border of the video. Right: The right
812
+ # edge of the watermark is aligned with the right border of the
813
+ # video. Center: The watermark is centered between the left and
814
+ # right borders.
815
+ # * `:horizontal_offset` - (String) The amount by which you want
816
+ # the horizontal position of the watermark to be offset from the
817
+ # position specified by HorizontalAlign: number of pixels (px):
818
+ # The minimum value is 0 pixels, and the maximum value is the
819
+ # value of MaxWidth. integer percentage (%): The range of valid
820
+ # values is 0 to 100. For example, if you specify Left for
821
+ # HorizontalAlign and 5px for HorizontalOffset, the left side of
822
+ # the watermark appears 5 pixels from the left border of the
823
+ # output video. HorizontalOffset is only valid when the value of
824
+ # HorizontalAlign is Left or Right. If you specify an offset that
825
+ # causes the watermark to extend beyond the left or right border
826
+ # and Elastic Transcoder has not added black bars, the watermark
827
+ # is cropped. If Elastic Transcoder has added black bars, the
828
+ # watermark extends into the black bars. If the watermark extends
829
+ # beyond the black bars, it is cropped. Use the value of Target
830
+ # to specify whether you want to include the black bars that are
831
+ # added by Elastic Transcoder, if any, in the offset calculation.
832
+ # * `:vertical_align` - (String) The vertical position of the
833
+ # watermark unless you specify a non-zero value for
834
+ # VerticalOffset: Top: The top edge of the watermark is aligned
835
+ # with the top border of the video. Bottom: The bottom edge of
836
+ # the watermark is aligned with the bottom border of the video.
837
+ # Center: The watermark is centered between the top and bottom
838
+ # borders.
839
+ # * `:vertical_offset` - (String) VerticalOffset The amount by
840
+ # which you want the vertical position of the watermark to be
841
+ # offset from the position specified by VerticalAlign: number of
842
+ # pixels (px): The minimum value is 0 pixels, and the maximum
843
+ # value is the value of MaxHeight. integer percentage (%): The
844
+ # range of valid values is 0 to 100. For example, if you specify
845
+ # Top for VerticalAlign and 5px for VerticalOffset, the top of
846
+ # the watermark appears 5 pixels from the top border of the
847
+ # output video. VerticalOffset is only valid when the value of
848
+ # VerticalAlign is Top or Bottom. If you specify an offset that
849
+ # causes the watermark to extend beyond the top or bottom border
850
+ # and Elastic Transcoder has not added black bars, the watermark
851
+ # is cropped. If Elastic Transcoder has added black bars, the
852
+ # watermark extends into the black bars. If the watermark extends
853
+ # beyond the black bars, it is cropped. Use the value of Target
854
+ # to specify whether you want Elastic Transcoder to include the
855
+ # black bars that are added by Elastic Transcoder, if any, in the
856
+ # offset calculation.
857
+ # * `:opacity` - (String) A percentage that indicates how much you
858
+ # want a watermark to obscure the video in the location where it
859
+ # appears. Valid values are 0 (the watermark is invisible) to 100
860
+ # (the watermark completely obscures the video in the specified
861
+ # location). The datatype of Opacity is float. Elastic Transcoder
862
+ # supports transparent .png graphics. If you use a transparent
863
+ # .png, the transparent portion of the video appears as if you
864
+ # had specified a value of 0 for Opacity. The .jpg file format
865
+ # doesn't support transparency.
866
+ # * `:target` - (String) A value that determines how Elastic
867
+ # Transcoder interprets values that you specified for
868
+ # HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:
869
+ # Content: HorizontalOffset and VerticalOffset values are
870
+ # calculated based on the borders of the video excluding black
871
+ # bars added by Elastic Transcoder, if any. In addition, MaxWidth
872
+ # and MaxHeight, if specified as a percentage, are calculated
873
+ # based on the borders of the video excluding black bars added by
874
+ # Elastic Transcoder, if any. Frame: HorizontalOffset and
875
+ # VerticalOffset values are calculated based on the borders of
876
+ # the video including black bars added by Elastic Transcoder, if
877
+ # any. In addition, MaxWidth and MaxHeight, if specified as a
878
+ # percentage, are calculated based on the borders of the video
879
+ # including black bars added by Elastic Transcoder, if any.
603
880
  # * `:audio` - (Hash) A section of the request body that specifies the
604
881
  # audio parameters.
605
882
  # * `:codec` - (String) The audio codec for the output file. This
@@ -699,6 +976,7 @@ module AWS
699
976
  # * `:fixed_gop` - (String)
700
977
  # * `:bit_rate` - (String)
701
978
  # * `:frame_rate` - (String)
979
+ # * `:max_frame_rate` - (String)
702
980
  # * `:resolution` - (String)
703
981
  # * `:aspect_ratio` - (String)
704
982
  # * `:max_width` - (String)
@@ -706,6 +984,17 @@ module AWS
706
984
  # * `:display_aspect_ratio` - (String)
707
985
  # * `:sizing_policy` - (String)
708
986
  # * `:padding_policy` - (String)
987
+ # * `:watermarks` - (Array<Hash>)
988
+ # * `:id` - (String)
989
+ # * `:max_width` - (String)
990
+ # * `:max_height` - (String)
991
+ # * `:sizing_policy` - (String)
992
+ # * `:horizontal_align` - (String)
993
+ # * `:horizontal_offset` - (String)
994
+ # * `:vertical_align` - (String)
995
+ # * `:vertical_offset` - (String)
996
+ # * `:opacity` - (String)
997
+ # * `:target` - (String)
709
998
  # * `:thumbnails` - (Hash)
710
999
  # * `:format` - (String)
711
1000
  # * `:interval` - (String)
@@ -772,6 +1061,9 @@ module AWS
772
1061
  # * `:duration` - (Integer)
773
1062
  # * `:width` - (Integer)
774
1063
  # * `:height` - (Integer)
1064
+ # * `:watermarks` - (Array<Hash>)
1065
+ # * `:preset_watermark_id` - (String)
1066
+ # * `:input_key` - (String)
775
1067
  # * `:outputs` - (Array<Hash>)
776
1068
  # * `:id` - (String)
777
1069
  # * `:key` - (String)
@@ -784,6 +1076,9 @@ module AWS
784
1076
  # * `:duration` - (Integer)
785
1077
  # * `:width` - (Integer)
786
1078
  # * `:height` - (Integer)
1079
+ # * `:watermarks` - (Array<Hash>)
1080
+ # * `:preset_watermark_id` - (String)
1081
+ # * `:input_key` - (String)
787
1082
  # * `:output_key_prefix` - (String)
788
1083
  # * `:playlists` - (Array<Hash>)
789
1084
  # * `:name` - (String)
@@ -834,6 +1129,9 @@ module AWS
834
1129
  # * `:duration` - (Integer)
835
1130
  # * `:width` - (Integer)
836
1131
  # * `:height` - (Integer)
1132
+ # * `:watermarks` - (Array<Hash>)
1133
+ # * `:preset_watermark_id` - (String)
1134
+ # * `:input_key` - (String)
837
1135
  # * `:outputs` - (Array<Hash>)
838
1136
  # * `:id` - (String)
839
1137
  # * `:key` - (String)
@@ -846,6 +1144,9 @@ module AWS
846
1144
  # * `:duration` - (Integer)
847
1145
  # * `:width` - (Integer)
848
1146
  # * `:height` - (Integer)
1147
+ # * `:watermarks` - (Array<Hash>)
1148
+ # * `:preset_watermark_id` - (String)
1149
+ # * `:input_key` - (String)
849
1150
  # * `:output_key_prefix` - (String)
850
1151
  # * `:playlists` - (Array<Hash>)
851
1152
  # * `:name` - (String)
@@ -917,6 +1218,7 @@ module AWS
917
1218
  # * `:fixed_gop` - (String)
918
1219
  # * `:bit_rate` - (String)
919
1220
  # * `:frame_rate` - (String)
1221
+ # * `:max_frame_rate` - (String)
920
1222
  # * `:resolution` - (String)
921
1223
  # * `:aspect_ratio` - (String)
922
1224
  # * `:max_width` - (String)
@@ -924,6 +1226,17 @@ module AWS
924
1226
  # * `:display_aspect_ratio` - (String)
925
1227
  # * `:sizing_policy` - (String)
926
1228
  # * `:padding_policy` - (String)
1229
+ # * `:watermarks` - (Array<Hash>)
1230
+ # * `:id` - (String)
1231
+ # * `:max_width` - (String)
1232
+ # * `:max_height` - (String)
1233
+ # * `:sizing_policy` - (String)
1234
+ # * `:horizontal_align` - (String)
1235
+ # * `:horizontal_offset` - (String)
1236
+ # * `:vertical_align` - (String)
1237
+ # * `:vertical_offset` - (String)
1238
+ # * `:opacity` - (String)
1239
+ # * `:target` - (String)
927
1240
  # * `:thumbnails` - (Hash)
928
1241
  # * `:format` - (String)
929
1242
  # * `:interval` - (String)
@@ -967,6 +1280,9 @@ module AWS
967
1280
  # * `:duration` - (Integer)
968
1281
  # * `:width` - (Integer)
969
1282
  # * `:height` - (Integer)
1283
+ # * `:watermarks` - (Array<Hash>)
1284
+ # * `:preset_watermark_id` - (String)
1285
+ # * `:input_key` - (String)
970
1286
  # * `:outputs` - (Array<Hash>)
971
1287
  # * `:id` - (String)
972
1288
  # * `:key` - (String)
@@ -979,6 +1295,9 @@ module AWS
979
1295
  # * `:duration` - (Integer)
980
1296
  # * `:width` - (Integer)
981
1297
  # * `:height` - (Integer)
1298
+ # * `:watermarks` - (Array<Hash>)
1299
+ # * `:preset_watermark_id` - (String)
1300
+ # * `:input_key` - (String)
982
1301
  # * `:output_key_prefix` - (String)
983
1302
  # * `:playlists` - (Array<Hash>)
984
1303
  # * `:name` - (String)
@@ -1053,6 +1372,7 @@ module AWS
1053
1372
  # * `:fixed_gop` - (String)
1054
1373
  # * `:bit_rate` - (String)
1055
1374
  # * `:frame_rate` - (String)
1375
+ # * `:max_frame_rate` - (String)
1056
1376
  # * `:resolution` - (String)
1057
1377
  # * `:aspect_ratio` - (String)
1058
1378
  # * `:max_width` - (String)
@@ -1060,6 +1380,17 @@ module AWS
1060
1380
  # * `:display_aspect_ratio` - (String)
1061
1381
  # * `:sizing_policy` - (String)
1062
1382
  # * `:padding_policy` - (String)
1383
+ # * `:watermarks` - (Array<Hash>)
1384
+ # * `:id` - (String)
1385
+ # * `:max_width` - (String)
1386
+ # * `:max_height` - (String)
1387
+ # * `:sizing_policy` - (String)
1388
+ # * `:horizontal_align` - (String)
1389
+ # * `:horizontal_offset` - (String)
1390
+ # * `:vertical_align` - (String)
1391
+ # * `:vertical_offset` - (String)
1392
+ # * `:opacity` - (String)
1393
+ # * `:target` - (String)
1063
1394
  # * `:thumbnails` - (Hash)
1064
1395
  # * `:format` - (String)
1065
1396
  # * `:interval` - (String)
@@ -1097,10 +1428,17 @@ module AWS
1097
1428
  # Calls the PUT UpdatePipeline API operation.
1098
1429
  # @param [Hash] options
1099
1430
  #
1100
- # * `:id` - *required* - (String)
1101
- # * `:name` - (String)
1102
- # * `:input_bucket` - (String)
1103
- # * `:role` - (String)
1431
+ # * `:id` - *required* - (String) The ID of the pipeline that you want
1432
+ # to update.
1433
+ # * `:name` - (String) The name of the pipeline. We recommend that the
1434
+ # name be unique within the AWS account, but uniqueness is not
1435
+ # enforced. Constraints: Maximum 40 characters
1436
+ # * `:input_bucket` - (String) The Amazon S3 bucket in which you saved
1437
+ # the media files that you want to transcode and the graphics that
1438
+ # you want to use as watermarks.
1439
+ # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
1440
+ # that you want Elastic Transcoder to use to transcode jobs for this
1441
+ # pipeline.
1104
1442
  # * `:notifications` - (Hash)
1105
1443
  # * `:progressing` - (String) The Amazon Simple Notification Service
1106
1444
  # (Amazon SNS) topic that you want to notify when Elastic
@@ -1111,20 +1449,206 @@ module AWS
1111
1449
  # notify when Elastic Transcoder encounters a warning condition.
1112
1450
  # * `:error` - (String) The Amazon SNS topic that you want to notify
1113
1451
  # when Elastic Transcoder encounters an error condition.
1114
- # * `:content_config` - (Hash)
1115
- # * `:bucket` - (String)
1116
- # * `:storage_class` - (String)
1117
- # * `:permissions` - (Array<Hash>)
1118
- # * `:grantee_type` - (String)
1119
- # * `:grantee` - (String)
1120
- # * `:access` - (Array<String>)
1121
- # * `:thumbnail_config` - (Hash)
1122
- # * `:bucket` - (String)
1123
- # * `:storage_class` - (String)
1124
- # * `:permissions` - (Array<Hash>)
1125
- # * `:grantee_type` - (String)
1126
- # * `:grantee` - (String)
1127
- # * `:access` - (Array<String>)
1452
+ # * `:content_config` - (Hash) The optional ContentConfig object
1453
+ # specifies information about the Amazon S3 bucket in which you want
1454
+ # Elastic Transcoder to save transcoded files and playlists: which
1455
+ # bucket to use, which users you want to have access to the files,
1456
+ # the type of access you want users to have, and the storage class
1457
+ # that you want to assign to the files. If you specify values for
1458
+ # ContentConfig, you must also specify values for ThumbnailConfig. If
1459
+ # you specify values for ContentConfig and ThumbnailConfig, omit the
1460
+ # OutputBucket object. Bucket: The Amazon S3 bucket in which you want
1461
+ # Elastic Transcoder to save transcoded files and playlists.
1462
+ # Permissions (Optional): The Permissions object specifies which
1463
+ # users you want to have access to transcoded files and the type of
1464
+ # access you want them to have. You can grant permissions to a
1465
+ # maximum of 30 users and/or predefined Amazon S3 groups. Grantee
1466
+ # Type: Specify the type of value that appears in the Grantee object:
1467
+ # Canonical: The value in the Grantee object is either the canonical
1468
+ # user ID for an AWS account or an origin access identity for an
1469
+ # Amazon CloudFront distribution. For more information about
1470
+ # canonical user IDs, see Access Control List (ACL) Overview in the
1471
+ # Amazon Simple Storage Service Developer Guide. For more information
1472
+ # about using CloudFront origin access identities to require that
1473
+ # users use CloudFront URLs instead of Amazon S3 URLs, see Using an
1474
+ # Origin Access Identity to Restrict Access to Your Amazon S3
1475
+ # Content. A canonical user ID is not the same as an AWS account
1476
+ # number. Email: The value in the Grantee object is the registered
1477
+ # email address of an AWS account. Group: The value in the Grantee
1478
+ # object is one of the following predefined Amazon S3 groups:
1479
+ # AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user
1480
+ # or group that you want to have access to transcoded files and
1481
+ # playlists. To identify the user or group, you can specify the
1482
+ # canonical user ID for an AWS account, an origin access identity for
1483
+ # a CloudFront distribution, the registered email address of an AWS
1484
+ # account, or a predefined Amazon S3 group Access: The permission
1485
+ # that you want to give to the AWS user that you specified in
1486
+ # Grantee. Permissions are granted on the files that Elastic
1487
+ # Transcoder adds to the bucket, including playlists and video files.
1488
+ # Valid values include: READ: The grantee can read the objects and
1489
+ # metadata for objects that Elastic Transcoder adds to the Amazon S3
1490
+ # bucket. READ_ACP: The grantee can read the object ACL for objects
1491
+ # that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP:
1492
+ # The grantee can write the ACL for the objects that Elastic
1493
+ # Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee
1494
+ # has READ, READ_ACP, and WRITE_ACP permissions for the objects that
1495
+ # Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The
1496
+ # Amazon S3 storage class, Standard or ReducedRedundancy, that you
1497
+ # want Elastic Transcoder to assign to the video files and playlists
1498
+ # that it stores in your Amazon S3 bucket.
1499
+ # * `:bucket` - (String) The Amazon S3 bucket in which you want
1500
+ # Elastic Transcoder to save the transcoded files. Specify this
1501
+ # value when all of the following are `true` : You want to save
1502
+ # transcoded files, thumbnails (if any), and playlists (if any)
1503
+ # together in one bucket. You do not want to specify the users or
1504
+ # groups who have access to the transcoded files, thumbnails, and
1505
+ # playlists. You do not want to specify the permissions that
1506
+ # Elastic Transcoder grants to the files. You want to associate the
1507
+ # transcoded files and thumbnails with the Amazon S3 Standard
1508
+ # storage class. If you want to save transcoded files and playlists
1509
+ # in one bucket and thumbnails in another bucket, specify which
1510
+ # users can access the transcoded files or the permissions the
1511
+ # users have, or change the Amazon S3 storage class, omit
1512
+ # OutputBucket and specify values for ContentConfig and
1513
+ # ThumbnailConfig instead.
1514
+ # * `:storage_class` - (String) The Amazon S3 storage class, Standard
1515
+ # or ReducedRedundancy, that you want Elastic Transcoder to assign
1516
+ # to the video files and playlists that it stores in your Amazon S3
1517
+ # bucket.
1518
+ # * `:permissions` - (Array<Hash>) Optional. The Permissions object
1519
+ # specifies which users and/or predefined Amazon S3 groups you want
1520
+ # to have access to transcoded files and playlists, and the type of
1521
+ # access you want them to have. You can grant permissions to a
1522
+ # maximum of 30 users and/or predefined Amazon S3 groups. If you
1523
+ # include Permissions, Elastic Transcoder grants only the
1524
+ # permissions that you specify. It does not grant full permissions
1525
+ # to the owner of the role specified by Role. If you want that user
1526
+ # to have full control, you must explicitly grant full control to
1527
+ # the user. If you omit Permissions, Elastic Transcoder grants full
1528
+ # control over the transcoded files and playlists to the owner of
1529
+ # the role specified by Role, and grants no other permissions to
1530
+ # any other user or group.
1531
+ # * `:grantee_type` - (String) The type of value that appears in
1532
+ # the Grantee object: Canonical: Either the canonical user ID for
1533
+ # an AWS account or an origin access identity for an Amazon
1534
+ # CloudFront distribution. A canonical user ID is not the same as
1535
+ # an AWS account number. Email: The registered email address of
1536
+ # an AWS account. Group: One of the following predefined Amazon
1537
+ # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
1538
+ # * `:grantee` - (String) The AWS user or group that you want to
1539
+ # have access to transcoded files and playlists. To identify the
1540
+ # user or group, you can specify the canonical user ID for an AWS
1541
+ # account, an origin access identity for a CloudFront
1542
+ # distribution, the registered email address of an AWS account,
1543
+ # or a predefined Amazon S3 group.
1544
+ # * `:access` - (Array<String>) The permission that you want to
1545
+ # give to the AWS user that is listed in Grantee. Valid values
1546
+ # include: READ: The grantee can read the thumbnails and metadata
1547
+ # for thumbnails that Elastic Transcoder adds to the Amazon S3
1548
+ # bucket. READ_ACP: The grantee can read the object ACL for
1549
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
1550
+ # bucket. WRITE_ACP: The grantee can write the ACL for the
1551
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
1552
+ # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
1553
+ # WRITE_ACP permissions for the thumbnails that Elastic
1554
+ # Transcoder adds to the Amazon S3 bucket.
1555
+ # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
1556
+ # several values, including the Amazon S3 bucket in which you want
1557
+ # Elastic Transcoder to save thumbnail files, which users you want to
1558
+ # have access to the files, the type of access you want users to
1559
+ # have, and the storage class that you want to assign to the files.
1560
+ # If you specify values for ContentConfig, you must also specify
1561
+ # values for ThumbnailConfig even if you don't want to create
1562
+ # thumbnails. If you specify values for ContentConfig and
1563
+ # ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon
1564
+ # S3 bucket in which you want Elastic Transcoder to save thumbnail
1565
+ # files. Permissions (Optional): The Permissions object specifies
1566
+ # which users and/or predefined Amazon S3 groups you want to have
1567
+ # access to thumbnail files, and the type of access you want them to
1568
+ # have. You can grant permissions to a maximum of 30 users and/or
1569
+ # predefined Amazon S3 groups. GranteeType: Specify the type of value
1570
+ # that appears in the Grantee object: Canonical: The value in the
1571
+ # Grantee object is either the canonical user ID for an AWS account
1572
+ # or an origin access identity for an Amazon CloudFront distribution.
1573
+ # A canonical user ID is not the same as an AWS account number.
1574
+ # Email: The value in the Grantee object is the registered email
1575
+ # address of an AWS account. Group: The value in the Grantee object
1576
+ # is one of the following predefined Amazon S3 groups: AllUsers,
1577
+ # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
1578
+ # that you want to have access to thumbnail files. To identify the
1579
+ # user or group, you can specify the canonical user ID for an AWS
1580
+ # account, an origin access identity for a CloudFront distribution,
1581
+ # the registered email address of an AWS account, or a predefined
1582
+ # Amazon S3 group. Access: The permission that you want to give to
1583
+ # the AWS user that you specified in Grantee. Permissions are granted
1584
+ # on the thumbnail files that Elastic Transcoder adds to the bucket.
1585
+ # Valid values include: READ: The grantee can read the thumbnails and
1586
+ # metadata for objects that Elastic Transcoder adds to the Amazon S3
1587
+ # bucket. READ_ACP: The grantee can read the object ACL for
1588
+ # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
1589
+ # WRITE_ACP: The grantee can write the ACL for the thumbnails that
1590
+ # Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
1591
+ # grantee has READ, READ_ACP, and WRITE_ACP permissions for the
1592
+ # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
1593
+ # StorageClass: The Amazon S3 storage class, Standard or
1594
+ # ReducedRedundancy, that you want Elastic Transcoder to assign to
1595
+ # the thumbnails that it stores in your Amazon S3 bucket.
1596
+ # * `:bucket` - (String) The Amazon S3 bucket in which you want
1597
+ # Elastic Transcoder to save the transcoded files. Specify this
1598
+ # value when all of the following are `true` : You want to save
1599
+ # transcoded files, thumbnails (if any), and playlists (if any)
1600
+ # together in one bucket. You do not want to specify the users or
1601
+ # groups who have access to the transcoded files, thumbnails, and
1602
+ # playlists. You do not want to specify the permissions that
1603
+ # Elastic Transcoder grants to the files. You want to associate the
1604
+ # transcoded files and thumbnails with the Amazon S3 Standard
1605
+ # storage class. If you want to save transcoded files and playlists
1606
+ # in one bucket and thumbnails in another bucket, specify which
1607
+ # users can access the transcoded files or the permissions the
1608
+ # users have, or change the Amazon S3 storage class, omit
1609
+ # OutputBucket and specify values for ContentConfig and
1610
+ # ThumbnailConfig instead.
1611
+ # * `:storage_class` - (String) The Amazon S3 storage class, Standard
1612
+ # or ReducedRedundancy, that you want Elastic Transcoder to assign
1613
+ # to the video files and playlists that it stores in your Amazon S3
1614
+ # bucket.
1615
+ # * `:permissions` - (Array<Hash>) Optional. The Permissions object
1616
+ # specifies which users and/or predefined Amazon S3 groups you want
1617
+ # to have access to transcoded files and playlists, and the type of
1618
+ # access you want them to have. You can grant permissions to a
1619
+ # maximum of 30 users and/or predefined Amazon S3 groups. If you
1620
+ # include Permissions, Elastic Transcoder grants only the
1621
+ # permissions that you specify. It does not grant full permissions
1622
+ # to the owner of the role specified by Role. If you want that user
1623
+ # to have full control, you must explicitly grant full control to
1624
+ # the user. If you omit Permissions, Elastic Transcoder grants full
1625
+ # control over the transcoded files and playlists to the owner of
1626
+ # the role specified by Role, and grants no other permissions to
1627
+ # any other user or group.
1628
+ # * `:grantee_type` - (String) The type of value that appears in
1629
+ # the Grantee object: Canonical: Either the canonical user ID for
1630
+ # an AWS account or an origin access identity for an Amazon
1631
+ # CloudFront distribution. A canonical user ID is not the same as
1632
+ # an AWS account number. Email: The registered email address of
1633
+ # an AWS account. Group: One of the following predefined Amazon
1634
+ # S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.
1635
+ # * `:grantee` - (String) The AWS user or group that you want to
1636
+ # have access to transcoded files and playlists. To identify the
1637
+ # user or group, you can specify the canonical user ID for an AWS
1638
+ # account, an origin access identity for a CloudFront
1639
+ # distribution, the registered email address of an AWS account,
1640
+ # or a predefined Amazon S3 group.
1641
+ # * `:access` - (Array<String>) The permission that you want to
1642
+ # give to the AWS user that is listed in Grantee. Valid values
1643
+ # include: READ: The grantee can read the thumbnails and metadata
1644
+ # for thumbnails that Elastic Transcoder adds to the Amazon S3
1645
+ # bucket. READ_ACP: The grantee can read the object ACL for
1646
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
1647
+ # bucket. WRITE_ACP: The grantee can write the ACL for the
1648
+ # thumbnails that Elastic Transcoder adds to the Amazon S3
1649
+ # bucket. FULL_CONTROL: The grantee has READ, READ_ACP, and
1650
+ # WRITE_ACP permissions for the thumbnails that Elastic
1651
+ # Transcoder adds to the Amazon S3 bucket.
1128
1652
  # @return [Core::Response]
1129
1653
  # The #data method of the response object returns
1130
1654
  # a hash with the following structure: