aws-sdk 1.11.2 → 1.11.3

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.
@@ -11,6 +11,8 @@
11
11
  # ANY KIND, either express or implied. See the License for the specific
12
12
  # language governing permissions and limitations under the License.
13
13
 
14
+ require 'base64'
15
+
14
16
  module AWS
15
17
  class EC2
16
18
 
@@ -575,11 +577,12 @@ module AWS
575
577
  images.create(options.merge(:instance_id => id, :name => name))
576
578
  end
577
579
 
578
- # Retrieves the console output for the instance.
579
- #
580
- # @return [String] the console output.
580
+ # Retrieves the console output for the instance, returning +nil+ if it
581
+ # is not available yet.
582
+ # @return [String] the console output
583
+ # @return [nil] if no output is available
581
584
  def console_output
582
- output = client.get_console_output(:instance_id => self.id).output
585
+ output = client.get_console_output(:instance_id => self.id)[:output]
583
586
  Base64.decode64(output) if output
584
587
  end
585
588
 
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method check_dns_availability(options = {})
26
26
  # Calls the CheckDNSAvailability API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:cname_prefix` - *required* - (String) The prefix used when this
29
30
  # CNAME is reserved.
30
31
  # @return [Core::Response]
@@ -37,6 +38,7 @@ module AWS
37
38
  # @!method create_application(options = {})
38
39
  # Calls the CreateApplication API operation.
39
40
  # @param [Hash] options
41
+ #
40
42
  # * `:application_name` - *required* - (String) The name of the
41
43
  # application. Constraint: This name must be unique within your
42
44
  # account. If the specified name already exists, the action returns
@@ -57,6 +59,7 @@ module AWS
57
59
  # @!method create_application_version(options = {})
58
60
  # Calls the CreateApplicationVersion API operation.
59
61
  # @param [Hash] options
62
+ #
60
63
  # * `:application_name` - *required* - (String) The name of the
61
64
  # application. If no application is found with this name, and
62
65
  # AutoCreateApplication is `false` , returns an InvalidParameterValue
@@ -106,6 +109,7 @@ module AWS
106
109
  # @!method create_configuration_template(options = {})
107
110
  # Calls the CreateConfigurationTemplate API operation.
108
111
  # @param [Hash] options
112
+ #
109
113
  # * `:application_name` - *required* - (String) The name of the
110
114
  # application to associate with this configuration template. If no
111
115
  # application is found with this name, AWS Elastic Beanstalk returns
@@ -173,6 +177,7 @@ module AWS
173
177
  # @!method create_environment(options = {})
174
178
  # Calls the CreateEnvironment API operation.
175
179
  # @param [Hash] options
180
+ #
176
181
  # * `:application_name` - *required* - (String) The name of the
177
182
  # application that contains the version to be deployed. If no
178
183
  # application is found with this name, CreateEnvironment returns an
@@ -256,6 +261,7 @@ module AWS
256
261
  # @!method create_storage_location(options = {})
257
262
  # Calls the CreateStorageLocation API operation.
258
263
  # @param [Hash] options
264
+ #
259
265
  # @return [Core::Response]
260
266
  # The #data method of the response object returns
261
267
  # a hash with the following structure:
@@ -265,6 +271,7 @@ module AWS
265
271
  # @!method delete_application(options = {})
266
272
  # Calls the DeleteApplication API operation.
267
273
  # @param [Hash] options
274
+ #
268
275
  # * `:application_name` - *required* - (String) The name of the
269
276
  # application to delete.
270
277
  # @return [Core::Response]
@@ -272,6 +279,7 @@ module AWS
272
279
  # @!method delete_application_version(options = {})
273
280
  # Calls the DeleteApplicationVersion API operation.
274
281
  # @param [Hash] options
282
+ #
275
283
  # * `:application_name` - *required* - (String) The name of the
276
284
  # application to delete releases from.
277
285
  # * `:version_label` - *required* - (String) The label of the version
@@ -287,6 +295,7 @@ module AWS
287
295
  # @!method delete_configuration_template(options = {})
288
296
  # Calls the DeleteConfigurationTemplate API operation.
289
297
  # @param [Hash] options
298
+ #
290
299
  # * `:application_name` - *required* - (String) The name of the
291
300
  # application to delete the configuration template from.
292
301
  # * `:template_name` - *required* - (String) The name of the
@@ -296,6 +305,7 @@ module AWS
296
305
  # @!method delete_environment_configuration(options = {})
297
306
  # Calls the DeleteEnvironmentConfiguration API operation.
298
307
  # @param [Hash] options
308
+ #
299
309
  # * `:application_name` - *required* - (String) The name of the
300
310
  # application the environment is associated with.
301
311
  # * `:environment_name` - *required* - (String) The name of the
@@ -305,6 +315,7 @@ module AWS
305
315
  # @!method describe_application_versions(options = {})
306
316
  # Calls the DescribeApplicationVersions API operation.
307
317
  # @param [Hash] options
318
+ #
308
319
  # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
309
320
  # restricts the returned descriptions to only include ones that are
310
321
  # associated with the specified application.
@@ -328,6 +339,7 @@ module AWS
328
339
  # @!method describe_applications(options = {})
329
340
  # Calls the DescribeApplications API operation.
330
341
  # @param [Hash] options
342
+ #
331
343
  # * `:application_names` - (Array<String>) If specified, AWS Elastic
332
344
  # Beanstalk restricts the returned descriptions to only include those
333
345
  # with the specified names.
@@ -346,6 +358,7 @@ module AWS
346
358
  # @!method describe_configuration_options(options = {})
347
359
  # Calls the DescribeConfigurationOptions API operation.
348
360
  # @param [Hash] options
361
+ #
349
362
  # * `:application_name` - (String) The name of the application
350
363
  # associated with the configuration template or environment. Only
351
364
  # needed if you want to describe the configuration options associated
@@ -384,6 +397,7 @@ module AWS
384
397
  # @!method describe_configuration_settings(options = {})
385
398
  # Calls the DescribeConfigurationSettings API operation.
386
399
  # @param [Hash] options
400
+ #
387
401
  # * `:application_name` - *required* - (String) The application for the
388
402
  # environment or configuration template.
389
403
  # * `:template_name` - (String) The name of the configuration template
@@ -419,6 +433,7 @@ module AWS
419
433
  # @!method describe_environment_resources(options = {})
420
434
  # Calls the DescribeEnvironmentResources API operation.
421
435
  # @param [Hash] options
436
+ #
422
437
  # * `:environment_id` - (String) The ID of the environment to retrieve
423
438
  # AWS resource usage data. Condition: You must specify either this or
424
439
  # an EnvironmentName, or both. If you do not specify either, AWS
@@ -448,6 +463,7 @@ module AWS
448
463
  # @!method describe_environments(options = {})
449
464
  # Calls the DescribeEnvironments API operation.
450
465
  # @param [Hash] options
466
+ #
451
467
  # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
452
468
  # restricts the returned descriptions to include only those that are
453
469
  # associated with this application.
@@ -496,6 +512,7 @@ module AWS
496
512
  # @!method describe_events(options = {})
497
513
  # Calls the DescribeEvents API operation.
498
514
  # @param [Hash] options
515
+ #
499
516
  # * `:application_name` - (String) If specified, AWS Elastic Beanstalk
500
517
  # restricts the returned descriptions to include only those
501
518
  # associated with this application.
@@ -551,6 +568,7 @@ module AWS
551
568
  # @!method list_available_solution_stacks(options = {})
552
569
  # Calls the ListAvailableSolutionStacks API operation.
553
570
  # @param [Hash] options
571
+ #
554
572
  # @return [Core::Response]
555
573
  # The #data method of the response object returns
556
574
  # a hash with the following structure:
@@ -563,6 +581,7 @@ module AWS
563
581
  # @!method rebuild_environment(options = {})
564
582
  # Calls the RebuildEnvironment API operation.
565
583
  # @param [Hash] options
584
+ #
566
585
  # * `:environment_id` - (String) The ID of the environment to rebuild.
567
586
  # Condition: You must specify either this or an EnvironmentName, or
568
587
  # both. If you do not specify either, AWS Elastic Beanstalk returns
@@ -576,6 +595,7 @@ module AWS
576
595
  # @!method request_environment_info(options = {})
577
596
  # Calls the RequestEnvironmentInfo API operation.
578
597
  # @param [Hash] options
598
+ #
579
599
  # * `:environment_id` - (String) The ID of the environment of the
580
600
  # requested data. If no such environment is found,
581
601
  # RequestEnvironmentInfo returns an InvalidParameterValue error.
@@ -596,6 +616,7 @@ module AWS
596
616
  # @!method restart_app_server(options = {})
597
617
  # Calls the RestartAppServer API operation.
598
618
  # @param [Hash] options
619
+ #
599
620
  # * `:environment_id` - (String) The ID of the environment to restart
600
621
  # the server for. Condition: You must specify either this or an
601
622
  # EnvironmentName, or both. If you do not specify either, AWS Elastic
@@ -609,6 +630,7 @@ module AWS
609
630
  # @!method retrieve_environment_info(options = {})
610
631
  # Calls the RetrieveEnvironmentInfo API operation.
611
632
  # @param [Hash] options
633
+ #
612
634
  # * `:environment_id` - (String) The ID of the data's environment. If
613
635
  # no such environment is found, returns an InvalidParameterValue
614
636
  # error. Condition: You must specify either this or an
@@ -635,6 +657,7 @@ module AWS
635
657
  # @!method swap_environment_cnam_es(options = {})
636
658
  # Calls the SwapEnvironmentCNAMEs API operation.
637
659
  # @param [Hash] options
660
+ #
638
661
  # * `:source_environment_id` - (String) The ID of the source
639
662
  # environment. Condition: You must specify at least the
640
663
  # SourceEnvironmentID or the SourceEnvironmentName. You may also
@@ -660,6 +683,7 @@ module AWS
660
683
  # @!method terminate_environment(options = {})
661
684
  # Calls the TerminateEnvironment API operation.
662
685
  # @param [Hash] options
686
+ #
663
687
  # * `:environment_id` - (String) The ID of the environment to
664
688
  # terminate. Condition: You must specify either this or an
665
689
  # EnvironmentName, or both. If you do not specify either, AWS Elastic
@@ -708,6 +732,7 @@ module AWS
708
732
  # @!method update_application(options = {})
709
733
  # Calls the UpdateApplication API operation.
710
734
  # @param [Hash] options
735
+ #
711
736
  # * `:application_name` - *required* - (String) The name of the
712
737
  # application to update. If no such application is found,
713
738
  # UpdateApplication returns an InvalidParameterValue error.
@@ -729,6 +754,7 @@ module AWS
729
754
  # @!method update_application_version(options = {})
730
755
  # Calls the UpdateApplicationVersion API operation.
731
756
  # @param [Hash] options
757
+ #
732
758
  # * `:application_name` - *required* - (String) The name of the
733
759
  # application associated with this version. If no application is
734
760
  # found with this name, UpdateApplication returns an
@@ -754,6 +780,7 @@ module AWS
754
780
  # @!method update_configuration_template(options = {})
755
781
  # Calls the UpdateConfigurationTemplate API operation.
756
782
  # @param [Hash] options
783
+ #
757
784
  # * `:application_name` - *required* - (String) The name of the
758
785
  # application associated with the configuration template to update.
759
786
  # If no application is found with this name,
@@ -796,6 +823,7 @@ module AWS
796
823
  # @!method update_environment(options = {})
797
824
  # Calls the UpdateEnvironment API operation.
798
825
  # @param [Hash] options
826
+ #
799
827
  # * `:environment_id` - (String) The ID of the environment to update.
800
828
  # If no environment with this ID exists, AWS Elastic Beanstalk
801
829
  # returns an InvalidParameterValue error. Condition: You must specify
@@ -861,6 +889,7 @@ module AWS
861
889
  # @!method validate_configuration_settings(options = {})
862
890
  # Calls the ValidateConfigurationSettings API operation.
863
891
  # @param [Hash] options
892
+ #
864
893
  # * `:application_name` - *required* - (String) The name of the
865
894
  # application that the configuration template or environment belongs
866
895
  # to.
@@ -38,167 +38,172 @@ module AWS
38
38
  # @!method cancel_job(options = {})
39
39
  # Calls the DELETE CancelJob API operation.
40
40
  # @param [Hash] options
41
- # * `:id` - *required* - (String) The identifier of the job that you want
42
- # to delete. To get a list of the jobs (including their jobId) that
43
- # have a status of Submitted, use the ListJobsByStatus API action.
41
+ #
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)
44
+ # that have a status of Submitted, use the ListJobsByStatus API
45
+ # action.
44
46
  # @return [Core::Response]
45
47
 
46
48
  # @!method create_job(options = {})
47
49
  # Calls the POST CreateJob API operation.
48
50
  # @param [Hash] options
49
- # * `:pipeline_id` - (String) The Id of the pipeline that you want
50
- # Elastic Transcoder to use for transcoding. The pipeline determines
51
- # several settings, including the Amazon S3 bucket from which Elastic
52
- # Transcoder gets the files to transcode and the bucket into which
53
- # Elastic Transcoder puts the transcoded files.
54
- # * `:input` - (Hash) A section of the request body that provides
55
- # information about the file that is being transcoded.
56
- # * `:key` - (String) The name of the file to transcode. Elsewhere in
57
- # the body of the JSON block is the the ID of the pipeline to use for
58
- # processing the job. The InputBucket object in that pipeline tells
59
- # Elastic Transcoder which Amazon S3 bucket to get the file from. If
60
- # the file name includes a prefix, such as cooking/lasagna.mpg,
61
- # include the prefix in the key. If the file isn't in the specified
62
- # bucket, Elastic Transcoder returns an error.
63
- # * `:frame_rate` - (String) The frame rate of the input file. If you
64
- # want Elastic Transcoder to automatically detect the frame rate of
65
- # the input file, specify auto. If you want to specify the frame rate
66
- # for the input file, enter one of the following values: 10, 15,
67
- # 23.97, 24, 25, 29.97, 30, 60 If you specify a value other than
68
- # auto, Elastic Transcoder disables automatic detection of the frame
69
- # rate.
70
- # * `:resolution` - (String) This value must be auto, which causes
71
- # Elastic Transcoder to automatically detect the resolution of the
72
- # input file.
73
- # * `:aspect_ratio` - (String) The aspect ratio of the input file. If
74
- # you want Elastic Transcoder to automatically detect the aspect
75
- # ratio of the input file, specify auto. If you want to specify the
76
- # aspect ratio for the output file, enter one of the following
77
- # values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than auto,
78
- # Elastic Transcoder disables automatic detection of the aspect
79
- # ratio.
80
- # * `:interlaced` - (String) Whether the input file is interlaced. If
81
- # you want Elastic Transcoder to automatically detect whether the
82
- # input file is interlaced, specify auto. If you want to specify
83
- # whether the input file is interlaced, enter one of the following
84
- # values: `true` , `false` If you specify a value other than auto,
85
- # Elastic Transcoder disables automatic detection of interlacing.
86
- # * `:container` - (String) The container type for the input file. If
87
- # you want Elastic Transcoder to automatically detect the container
88
- # type of the input file, specify auto. If you want to specify the
89
- # container type for the input file, enter one of the following
90
- # values: 3gp, asf, avi, divx, flv, mkv, mov, mp4, mpeg, mpeg-ps,
91
- # mpeg-ts, mxf, ogg, vob, wav, webm
92
- # * `:output` - (Hash)
93
- # * `:key` - (String) The name to assign to the transcoded file.
94
- # Elastic Transcoder saves the file in the Amazon S3 bucket specified
95
- # by the OutputBucket object in the pipeline that is specified by the
96
- # pipeline ID. If a file with the specified name already exists in
97
- # the output bucket, the job fails.
98
- # * `:thumbnail_pattern` - (String) Whether you want Elastic Transcoder
99
- # to create thumbnails for your videos and, if so, how you want
100
- # Elastic Transcoder to name the files. If you don't want Elastic
101
- # Transcoder to create thumbnails, specify "". If you do want Elastic
102
- # Transcoder to create thumbnails, specify the information that you
103
- # want to include in the file name for each thumbnail. You can
104
- # specify the following values in any sequence: {count} (Required):
105
- # If you want to create thumbnails, you must include {count} in the
106
- # ThumbnailPattern object. Wherever you specify {count}, Elastic
107
- # Transcoder adds a five-digit sequence number (beginning with 00001)
108
- # to thumbnail file names. The number indicates where a given
109
- # thumbnail appears in the sequence of thumbnails for a transcoded
110
- # file. If you specify a literal value and/or {resolution} but you
111
- # omit {count}, Elastic Transcoder returns a validation error and
112
- # does not create the job. Literal values (Optional): You can specify
113
- # literal values anywhere in the ThumbnailPattern object. For
114
- # example, you can include them as a file name prefix or as a
115
- # delimiter between {resolution} and {count}. {resolution}
116
- # (Optional): If you want Elastic Transcoder to include the
117
- # resolution in the file name, include {resolution} in the
118
- # ThumbnailPattern object. When creating thumbnails, Elastic
119
- # Transcoder automatically saves the files in the format (.jpg or
120
- # .png) that appears in the preset that you specified in the PresetID
121
- # value of CreateJobOutput. Elastic Transcoder also appends the
122
- # applicable file name extension.
123
- # * `:rotate` - (String) The number of degrees clockwise by which you
124
- # want Elastic Transcoder to rotate the output relative to the input.
125
- # Enter one of the following values: auto, 0, 90, 180, 270. The value
126
- # auto generally works only if the file that you're transcoding
127
- # contains rotation metadata.
128
- # * `:preset_id` - (String) The Id of the preset to use for this job.
129
- # The preset determines the audio, video, and thumbnail settings that
130
- # Elastic Transcoder uses for transcoding.
131
- # * `:segment_duration` - (String) If you specify a preset in PresetId
132
- # for which the value of Container is ts (MPEG-TS), SegmentDuration
133
- # is the duration of each .ts file in seconds. The range of valid
134
- # values is 1 to 60 seconds.
135
- # * `:outputs` - (Array<Hash>) A section of the request body that
136
- # provides information about the transcoded (target) files. We
137
- # recommend that you use the Outputs syntax instead of the Output
138
- # syntax.
139
- # * `:key` - (String) The name to assign to the transcoded file.
140
- # Elastic Transcoder saves the file in the Amazon S3 bucket specified
141
- # by the OutputBucket object in the pipeline that is specified by the
142
- # pipeline ID. If a file with the specified name already exists in
143
- # the output bucket, the job fails.
144
- # * `:thumbnail_pattern` - (String) Whether you want Elastic Transcoder
145
- # to create thumbnails for your videos and, if so, how you want
146
- # Elastic Transcoder to name the files. If you don't want Elastic
147
- # Transcoder to create thumbnails, specify "". If you do want Elastic
148
- # Transcoder to create thumbnails, specify the information that you
149
- # want to include in the file name for each thumbnail. You can
150
- # specify the following values in any sequence: {count} (Required):
151
- # If you want to create thumbnails, you must include {count} in the
152
- # ThumbnailPattern object. Wherever you specify {count}, Elastic
153
- # Transcoder adds a five-digit sequence number (beginning with 00001)
154
- # to thumbnail file names. The number indicates where a given
155
- # thumbnail appears in the sequence of thumbnails for a transcoded
156
- # file. If you specify a literal value and/or {resolution} but you
157
- # omit {count}, Elastic Transcoder returns a validation error and
158
- # does not create the job. Literal values (Optional): You can specify
159
- # literal values anywhere in the ThumbnailPattern object. For
160
- # example, you can include them as a file name prefix or as a
161
- # delimiter between {resolution} and {count}. {resolution}
162
- # (Optional): If you want Elastic Transcoder to include the
163
- # resolution in the file name, include {resolution} in the
164
- # ThumbnailPattern object. When creating thumbnails, Elastic
165
- # Transcoder automatically saves the files in the format (.jpg or
166
- # .png) that appears in the preset that you specified in the PresetID
167
- # value of CreateJobOutput. Elastic Transcoder also appends the
168
- # applicable file name extension.
169
- # * `:rotate` - (String) The number of degrees clockwise by which you
170
- # want Elastic Transcoder to rotate the output relative to the input.
171
- # Enter one of the following values: auto, 0, 90, 180, 270. The value
172
- # auto generally works only if the file that you're transcoding
173
- # contains rotation metadata.
174
- # * `:preset_id` - (String) The Id of the preset to use for this job.
175
- # The preset determines the audio, video, and thumbnail settings that
176
- # Elastic Transcoder uses for transcoding.
177
- # * `:segment_duration` - (String) If you specify a preset in PresetId
178
- # for which the value of Container is ts (MPEG-TS), SegmentDuration
179
- # is the duration of each .ts file in seconds. The range of valid
180
- # values is 1 to 60 seconds.
181
- # * `:output_key_prefix` - (String) The value, if any, that you want
182
- # Elastic Transcoder to prepend to the names of all files that this job
183
- # creates, including output files, thumbnails, and playlists.
184
- # * `:playlists` - (Array<Hash>) If you specify a preset in PresetId for
185
- # which the value of Container is ts (MPEG-TS), Playlists contains
186
- # information about the master playlists that you want Elastic
187
- # Transcoder to create. We recommend that you create only one master
188
- # playlist. The maximum number of master playlists in a job is 30.
189
- # * `:name` - (String) The name that you want Elastic Transcoder to
190
- # assign to the master playlist, for example, nyc-vacation.m3u8. The
191
- # name cannot include a / character. If you create more than one
192
- # master playlist (not recommended), the values of all Name objects
193
- # must be unique. Elastic Transcoder automatically appends .m3u8 to
194
- # the file name. If you include .m3u8 in Name, it will appear twice
195
- # in the file name.
196
- # * `:format` - (String) This value must currently be HLSv3.
197
- # * `:output_keys` - (Array<String>) For each output in this job that
198
- # you want to include in a master playlist, the value of the
199
- # Outputs:Key object. If you include more than one output in a
200
- # playlist, the value of SegmentDuration for all of the outputs must
201
- # be the same.
51
+ #
52
+ # * `:pipeline_id` - (String) The Id of the pipeline that you want
53
+ # Elastic Transcoder to use for transcoding. The pipeline determines
54
+ # several settings, including the Amazon S3 bucket from which Elastic
55
+ # Transcoder gets the files to transcode and the bucket into which
56
+ # Elastic Transcoder puts the transcoded files.
57
+ # * `:input` - (Hash) A section of the request body that provides
58
+ # information about the file that is being transcoded.
59
+ # * `:key` - (String) The name of the file to transcode. Elsewhere in
60
+ # the body of the JSON block is the the ID of the pipeline to use
61
+ # for processing the job. The InputBucket object in that pipeline
62
+ # tells Elastic Transcoder which Amazon S3 bucket to get the file
63
+ # from. If the file name includes a prefix, such as
64
+ # cooking/lasagna.mpg, include the prefix in the key. If the file
65
+ # isn't in the specified bucket, Elastic Transcoder returns an
66
+ # error.
67
+ # * `:frame_rate` - (String) The frame rate of the input file. If you
68
+ # want Elastic Transcoder to automatically detect the frame rate of
69
+ # the input file, specify auto. If you want to specify the frame
70
+ # rate for the input file, enter one of the following values: 10,
71
+ # 15, 23.97, 24, 25, 29.97, 30, 60 If you specify a value other
72
+ # than auto, Elastic Transcoder disables automatic detection of the
73
+ # frame rate.
74
+ # * `:resolution` - (String) This value must be auto, which causes
75
+ # Elastic Transcoder to automatically detect the resolution of the
76
+ # input file.
77
+ # * `:aspect_ratio` - (String) The aspect ratio of the input file. If
78
+ # you want Elastic Transcoder to automatically detect the aspect
79
+ # ratio of the input file, specify auto. If you want to specify the
80
+ # aspect ratio for the output file, enter one of the following
81
+ # values: 1:1, 4:3, 3:2, 16:9 If you specify a value other than
82
+ # auto, Elastic Transcoder disables automatic detection of the
83
+ # aspect ratio.
84
+ # * `:interlaced` - (String) Whether the input file is interlaced. If
85
+ # you want Elastic Transcoder to automatically detect whether the
86
+ # input file is interlaced, specify auto. If you want to specify
87
+ # whether the input file is interlaced, enter one of the following
88
+ # values: `true` , `false` If you specify a value other than auto,
89
+ # Elastic Transcoder disables automatic detection of interlacing.
90
+ # * `:container` - (String) The container type for the input file. If
91
+ # you want Elastic Transcoder to automatically detect the container
92
+ # type of the input file, specify auto. If you want to specify the
93
+ # container type for the input file, enter one of the following
94
+ # values: 3gp, asf, avi, divx, flv, mkv, mov, mp4, mpeg, mpeg-ps,
95
+ # mpeg-ts, mxf, ogg, vob, wav, webm
96
+ # * `:output` - (Hash)
97
+ # * `:key` - (String) The name to assign to the transcoded file.
98
+ # Elastic Transcoder saves the file in the Amazon S3 bucket
99
+ # specified by the OutputBucket object in the pipeline that is
100
+ # specified by the pipeline ID. If a file with the specified name
101
+ # already exists in the output bucket, the job fails.
102
+ # * `:thumbnail_pattern` - (String) Whether you want Elastic
103
+ # Transcoder to create thumbnails for your videos and, if so, how
104
+ # you want Elastic Transcoder to name the files. If you don't want
105
+ # Elastic Transcoder to create thumbnails, specify "". If you do
106
+ # want Elastic Transcoder to create thumbnails, specify the
107
+ # information that you want to include in the file name for each
108
+ # thumbnail. You can specify the following values in any sequence:
109
+ # {count} (Required): If you want to create thumbnails, you must
110
+ # include {count} in the ThumbnailPattern object. Wherever you
111
+ # specify {count}, Elastic Transcoder adds a five-digit sequence
112
+ # number (beginning with 00001) to thumbnail file names. The number
113
+ # indicates where a given thumbnail appears in the sequence of
114
+ # thumbnails for a transcoded file. If you specify a literal value
115
+ # and/or {resolution} but you omit {count}, Elastic Transcoder
116
+ # returns a validation error and does not create the job. Literal
117
+ # values (Optional): You can specify literal values anywhere in the
118
+ # ThumbnailPattern object. For example, you can include them as a
119
+ # file name prefix or as a delimiter between {resolution} and
120
+ # {count}. {resolution} (Optional): If you want Elastic Transcoder
121
+ # to include the resolution in the file name, include {resolution}
122
+ # in the ThumbnailPattern object. When creating thumbnails, Elastic
123
+ # Transcoder automatically saves the files in the format (.jpg or
124
+ # .png) that appears in the preset that you specified in the
125
+ # PresetID value of CreateJobOutput. Elastic Transcoder also
126
+ # appends the applicable file name extension.
127
+ # * `:rotate` - (String) The number of degrees clockwise by which you
128
+ # want Elastic Transcoder to rotate the output relative to the
129
+ # input. Enter one of the following values: auto, 0, 90, 180, 270.
130
+ # The value auto generally works only if the file that you're
131
+ # transcoding contains rotation metadata.
132
+ # * `:preset_id` - (String) The Id of the preset to use for this job.
133
+ # The preset determines the audio, video, and thumbnail settings
134
+ # that Elastic Transcoder uses for transcoding.
135
+ # * `:segment_duration` - (String) If you specify a preset in
136
+ # PresetId for which the value of Container is ts (MPEG-TS),
137
+ # SegmentDuration is the duration of each .ts file in seconds. The
138
+ # range of valid values is 1 to 60 seconds.
139
+ # * `:outputs` - (Array<Hash>) A section of the request body that
140
+ # provides information about the transcoded (target) files. We
141
+ # recommend that you use the Outputs syntax instead of the Output
142
+ # syntax.
143
+ # * `:key` - (String) The name to assign to the transcoded file.
144
+ # Elastic Transcoder saves the file in the Amazon S3 bucket
145
+ # specified by the OutputBucket object in the pipeline that is
146
+ # specified by the pipeline ID. If a file with the specified name
147
+ # already exists in the output bucket, the job fails.
148
+ # * `:thumbnail_pattern` - (String) Whether you want Elastic
149
+ # Transcoder to create thumbnails for your videos and, if so, how
150
+ # you want Elastic Transcoder to name the files. If you don't want
151
+ # Elastic Transcoder to create thumbnails, specify "". If you do
152
+ # want Elastic Transcoder to create thumbnails, specify the
153
+ # information that you want to include in the file name for each
154
+ # thumbnail. You can specify the following values in any sequence:
155
+ # {count} (Required): If you want to create thumbnails, you must
156
+ # include {count} in the ThumbnailPattern object. Wherever you
157
+ # specify {count}, Elastic Transcoder adds a five-digit sequence
158
+ # number (beginning with 00001) to thumbnail file names. The number
159
+ # indicates where a given thumbnail appears in the sequence of
160
+ # thumbnails for a transcoded file. If you specify a literal value
161
+ # and/or {resolution} but you omit {count}, Elastic Transcoder
162
+ # returns a validation error and does not create the job. Literal
163
+ # values (Optional): You can specify literal values anywhere in the
164
+ # ThumbnailPattern object. For example, you can include them as a
165
+ # file name prefix or as a delimiter between {resolution} and
166
+ # {count}. {resolution} (Optional): If you want Elastic Transcoder
167
+ # to include the resolution in the file name, include {resolution}
168
+ # in the ThumbnailPattern object. When creating thumbnails, Elastic
169
+ # Transcoder automatically saves the files in the format (.jpg or
170
+ # .png) that appears in the preset that you specified in the
171
+ # PresetID value of CreateJobOutput. Elastic Transcoder also
172
+ # appends the applicable file name extension.
173
+ # * `:rotate` - (String) The number of degrees clockwise by which you
174
+ # want Elastic Transcoder to rotate the output relative to the
175
+ # input. Enter one of the following values: auto, 0, 90, 180, 270.
176
+ # The value auto generally works only if the file that you're
177
+ # transcoding contains rotation metadata.
178
+ # * `:preset_id` - (String) The Id of the preset to use for this job.
179
+ # The preset determines the audio, video, and thumbnail settings
180
+ # that Elastic Transcoder uses for transcoding.
181
+ # * `:segment_duration` - (String) If you specify a preset in
182
+ # PresetId for which the value of Container is ts (MPEG-TS),
183
+ # SegmentDuration is the duration of each .ts file in seconds. The
184
+ # range of valid values is 1 to 60 seconds.
185
+ # * `:output_key_prefix` - (String) The value, if any, that you want
186
+ # Elastic Transcoder to prepend to the names of all files that this
187
+ # job creates, including output files, thumbnails, and playlists.
188
+ # * `:playlists` - (Array<Hash>) If you specify a preset in PresetId
189
+ # for which the value of Container is ts (MPEG-TS), Playlists
190
+ # contains information about the master playlists that you want
191
+ # Elastic Transcoder to create. We recommend that you create only one
192
+ # master playlist. The maximum number of master playlists in a job is
193
+ # 30.
194
+ # * `:name` - (String) The name that you want Elastic Transcoder to
195
+ # assign to the master playlist, for example, nyc-vacation.m3u8.
196
+ # The name cannot include a / character. If you create more than
197
+ # one master playlist (not recommended), the values of all Name
198
+ # objects must be unique. Elastic Transcoder automatically appends
199
+ # .m3u8 to the file name. If you include .m3u8 in Name, it will
200
+ # appear twice in the file name.
201
+ # * `:format` - (String) This value must currently be HLSv3.
202
+ # * `:output_keys` - (Array<String>) For each output in this job that
203
+ # you want to include in a master playlist, the value of the
204
+ # Outputs:Key object. If you include more than one output in a
205
+ # playlist, the value of SegmentDuration for all of the outputs
206
+ # must be the same.
202
207
  # @return [Core::Response]
203
208
  # The #data method of the response object returns
204
209
  # a hash with the following structure:
@@ -249,156 +254,161 @@ module AWS
249
254
  # @!method create_pipeline(options = {})
250
255
  # Calls the POST CreatePipeline API operation.
251
256
  # @param [Hash] options
252
- # * `:name` - (String) The name of the pipeline. We recommend that the
253
- # name be unique within the AWS account, but uniqueness is not
254
- # enforced. Constraints: Maximum 40 characters.
255
- # * `:input_bucket` - (String) The Amazon S3 bucket in which you saved
256
- # the media files that you want to transcode.
257
- # * `:output_bucket` - (String) The Amazon S3 bucket in which you want
258
- # Elastic Transcoder to save the transcoded files. (Use this, or use
259
- # ContentConfig:Bucket plus ThumbnailConfig:Bucket.) Specify this value
260
- # when all of the following are `true` : You want to save transcoded
261
- # files, thumbnails (if any), and playlists (if any) together in one
262
- # bucket. You do not want to specify the users or groups who have
263
- # access to the transcoded files, thumbnails, and playlists. You do not
264
- # want to specify the permissions that Elastic Transcoder grants to the
265
- # files. When Elastic Transcoder saves files in OutputBucket, it grants
266
- # full control over the files only to the AWS account that owns the
267
- # role that is specified by Role. You want to associate the transcoded
268
- # files and thumbnails with the Amazon S3 Standard storage class. If
269
- # you want to save transcoded files and playlists in one bucket and
270
- # thumbnails in another bucket, specify which users can access the
271
- # transcoded files or the permissions the users have, or change the
272
- # Amazon S3 storage class, omit OutputBucket and specify values for
273
- # ContentConfig and ThumbnailConfig instead.
274
- # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
275
- # that you want Elastic Transcoder to use to create the pipeline.
276
- # * `:notifications` - (Hash) The Amazon Simple Notification Service
277
- # (Amazon SNS) topic that you want to notify to report job status. To
278
- # receive notifications, you must also subscribe to the new topic in
279
- # the Amazon SNS console. Progressing: The topic ARN for the Amazon
280
- # Simple Notification Service (Amazon SNS) topic that you want to
281
- # notify when Elastic Transcoder has started to process a job in this
282
- # pipeline. This is the ARN that Amazon SNS returned when you created
283
- # the topic. For more information, see Create a Topic in the Amazon
284
- # Simple Notification Service Developer Guide. Completed: The topic ARN
285
- # for the Amazon SNS topic that you want to notify when Elastic
286
- # Transcoder has finished processing a job in this pipeline. This is
287
- # the ARN that Amazon SNS returned when you created the topic. Warning:
288
- # The topic ARN for the Amazon SNS topic that you want to notify when
289
- # Elastic Transcoder encounters a warning condition while processing a
290
- # job in this pipeline. This is the ARN that Amazon SNS returned when
291
- # you created the topic. Error: The topic ARN for the Amazon SNS topic
292
- # that you want to notify when Elastic Transcoder encounters an error
293
- # condition while processing a job in this pipeline. This is the ARN
294
- # that Amazon SNS returned when you created the topic.
295
- # * `:progressing` - (String) The Amazon Simple Notification Service
296
- # (Amazon SNS) topic that you want to notify when Elastic Transcoder
297
- # has started to process the job.
298
- # * `:completed` - (String) The Amazon SNS topic that you want to
299
- # notify when Elastic Transcoder has finished processing the job.
300
- # * `:warning` - (String) The Amazon SNS topic that you want to notify
301
- # when Elastic Transcoder encounters a warning condition.
302
- # * `:error` - (String) The Amazon SNS topic that you want to notify
303
- # when Elastic Transcoder encounters an error condition.
304
- # * `:content_config` - (Hash) The optional ContentConfig object
305
- # specifies information about the Amazon S3 bucket in which you want
306
- # Elastic Transcoder to save transcoded files and playlists: which
307
- # bucket to use, which users you want to have access to the files, the
308
- # type of access you want users to have, and the storage class that you
309
- # want to assign to the files. If you specify values for ContentConfig,
310
- # you must also specify values for ThumbnailConfig. If you specify
311
- # values for ContentConfig and ThumbnailConfig, omit the OutputBucket
312
- # object. Bucket: The Amazon S3 bucket in which you want Elastic
313
- # Transcoder to save transcoded files and playlists. Permissions
314
- # (Optional): The Permissions object specifies which users you want to
315
- # have access to transcoded files and the type of access you want them
316
- # to have. You can grant permissions to a maximum of 30 users and/or
317
- # predefined Amazon S3 groups. Grantee Type: Specify the type of value
318
- # that appears in the Grantee object: Canonical: The value in the
319
- # Grantee object is either the canonical user ID for an AWS account or
320
- # an origin access identity for an Amazon CloudFront distribution. For
321
- # more information about canonical user IDs, see Access Control List
322
- # (ACL) Overview in the Amazon Simple Storage Service Developer Guide.
323
- # For more information about using CloudFront origin access identities
324
- # to require that users use CloudFront URLs instead of Amazon S3 URLs,
325
- # see Using an Origin Access Identity to Restrict Access to Your Amazon
326
- # S3 Content. A canonical user ID is not the same as an AWS account
327
- # number. Email: The value in the Grantee object is the registered
328
- # email address of an AWS account. Group: The value in the Grantee
329
- # object is one of the following predefined Amazon S3 groups: AllUsers,
330
- # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
331
- # that you want to have access to transcoded files and playlists. To
332
- # identify the user or group, you can specify the canonical user ID for
333
- # an AWS account, an origin access identity for a CloudFront
334
- # distribution, the registered email address of an AWS account, or a
335
- # predefined Amazon S3 group Access: The permission that you want to
336
- # give to the AWS user that you specified in Grantee. Permissions are
337
- # granted on the files that Elastic Transcoder adds to the bucket,
338
- # including playlists and video files. Valid values include: READ: The
339
- # grantee can read the objects and metadata for objects that Elastic
340
- # Transcoder adds to the Amazon S3 bucket. READ_ACP: The grantee can
341
- # read the object ACL for objects that Elastic Transcoder adds to the
342
- # Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the
343
- # objects that Elastic Transcoder adds to the Amazon S3 bucket.
344
- # FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
345
- # permissions for the objects that Elastic Transcoder adds to the
346
- # Amazon S3 bucket. StorageClass: The Amazon S3 storage class, Standard
347
- # or ReducedRedundancy, that you want Elastic Transcoder to assign to
348
- # the video files and playlists that it stores in your Amazon S3
349
- # bucket.
350
- # * `:bucket` - (String)
351
- # * `:storage_class` - (String)
352
- # * `:permissions` - (Array<Hash>)
353
- # * `:grantee_type` - (String)
354
- # * `:grantee` - (String)
355
- # * `:access` - (Array<String>)
356
- # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
357
- # several values, including the Amazon S3 bucket in which you want
358
- # Elastic Transcoder to save thumbnail files, which users you want to
359
- # have access to the files, the type of access you want users to have,
360
- # and the storage class that you want to assign to the files. If you
361
- # specify values for ContentConfig, you must also specify values for
362
- # ThumbnailConfig even if you don't want to create thumbnails. If you
363
- # specify values for ContentConfig and ThumbnailConfig, omit the
364
- # OutputBucket object. Bucket: The Amazon S3 bucket in which you want
365
- # Elastic Transcoder to save thumbnail files. Permissions (Optional):
366
- # The Permissions object specifies which users and/or predefined Amazon
367
- # S3 groups you want to have access to thumbnail files, and the type of
368
- # access you want them to have. You can grant permissions to a maximum
369
- # of 30 users and/or predefined Amazon S3 groups. GranteeType: Specify
370
- # the type of value that appears in the Grantee object: Canonical: The
371
- # value in the Grantee object is either the canonical user ID for an
372
- # AWS account or an origin access identity for an Amazon CloudFront
373
- # distribution. A canonical user ID is not the same as an AWS account
374
- # number. Email: The value in the Grantee object is the registered
375
- # email address of an AWS account. Group: The value in the Grantee
376
- # object is one of the following predefined Amazon S3 groups: AllUsers,
377
- # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
378
- # that you want to have access to thumbnail files. To identify the user
379
- # or group, you can specify the canonical user ID for an AWS account,
380
- # an origin access identity for a CloudFront distribution, the
381
- # registered email address of an AWS account, or a predefined Amazon S3
382
- # group. Access: The permission that you want to give to the AWS user
383
- # that you specified in Grantee. Permissions are granted on the
384
- # thumbnail files that Elastic Transcoder adds to the bucket. Valid
385
- # values include: READ: The grantee can read the thumbnails and
386
- # metadata for objects that Elastic Transcoder adds to the Amazon S3
387
- # bucket. READ_ACP: The grantee can read the object ACL for thumbnails
388
- # that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The
389
- # grantee can write the ACL for the thumbnails that Elastic Transcoder
390
- # adds to the Amazon S3 bucket. FULL_CONTROL: The grantee has READ,
391
- # READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic
392
- # Transcoder adds to the Amazon S3 bucket. StorageClass: The Amazon S3
393
- # storage class, Standard or ReducedRedundancy, that you want Elastic
394
- # Transcoder to assign to the thumbnails that it stores in your Amazon
395
- # S3 bucket.
396
- # * `:bucket` - (String)
397
- # * `:storage_class` - (String)
398
- # * `:permissions` - (Array<Hash>)
399
- # * `:grantee_type` - (String)
400
- # * `:grantee` - (String)
401
- # * `:access` - (Array<String>)
257
+ #
258
+ # * `:name` - (String) The name of the pipeline. We recommend that the
259
+ # name be unique within the AWS account, but uniqueness is not
260
+ # enforced. Constraints: Maximum 40 characters.
261
+ # * `:input_bucket` - (String) The Amazon S3 bucket in which you saved
262
+ # the media files that you want to transcode.
263
+ # * `:output_bucket` - (String) The Amazon S3 bucket in which you want
264
+ # Elastic Transcoder to save the transcoded files. (Use this, or use
265
+ # ContentConfig:Bucket plus ThumbnailConfig:Bucket.) Specify this
266
+ # value when all of the following are `true` : You want to save
267
+ # transcoded files, thumbnails (if any), and playlists (if any)
268
+ # together in one bucket. You do not want to specify the users or
269
+ # groups who have access to the transcoded files, thumbnails, and
270
+ # playlists. You do not want to specify the permissions that Elastic
271
+ # Transcoder grants to the files. When Elastic Transcoder saves files
272
+ # in OutputBucket, it grants full control over the files only to the
273
+ # AWS account that owns the role that is specified by Role. You want
274
+ # to associate the transcoded files and thumbnails with the Amazon S3
275
+ # Standard storage class. If you want to save transcoded files and
276
+ # playlists in one bucket and thumbnails in another bucket, specify
277
+ # which users can access the transcoded files or the permissions the
278
+ # users have, or change the Amazon S3 storage class, omit
279
+ # OutputBucket and specify values for ContentConfig and
280
+ # ThumbnailConfig instead.
281
+ # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
282
+ # that you want Elastic Transcoder to use to create the pipeline.
283
+ # * `:notifications` - (Hash) The Amazon Simple Notification Service
284
+ # (Amazon SNS) topic that you want to notify to report job status. To
285
+ # receive notifications, you must also subscribe to the new topic in
286
+ # the Amazon SNS console. Progressing: The topic ARN for the Amazon
287
+ # Simple Notification Service (Amazon SNS) topic that you want to
288
+ # notify when Elastic Transcoder has started to process a job in this
289
+ # pipeline. This is the ARN that Amazon SNS returned when you created
290
+ # the topic. For more information, see Create a Topic in the Amazon
291
+ # Simple Notification Service Developer Guide. Completed: The topic
292
+ # ARN for the Amazon SNS topic that you want to notify when Elastic
293
+ # Transcoder has finished processing a job in this pipeline. This is
294
+ # the ARN that Amazon SNS returned when you created the topic.
295
+ # Warning: The topic ARN for the Amazon SNS topic that you want to
296
+ # notify when Elastic Transcoder encounters a warning condition while
297
+ # processing a job in this pipeline. This is the ARN that Amazon SNS
298
+ # returned when you created the topic. Error: The topic ARN for the
299
+ # Amazon SNS topic that you want to notify when Elastic Transcoder
300
+ # encounters an error condition while processing a job in this
301
+ # pipeline. This is the ARN that Amazon SNS returned when you created
302
+ # the topic.
303
+ # * `:progressing` - (String) The Amazon Simple Notification Service
304
+ # (Amazon SNS) topic that you want to notify when Elastic
305
+ # Transcoder has started to process the job.
306
+ # * `:completed` - (String) The Amazon SNS topic that you want to
307
+ # notify when Elastic Transcoder has finished processing the job.
308
+ # * `:warning` - (String) The Amazon SNS topic that you want to
309
+ # notify when Elastic Transcoder encounters a warning condition.
310
+ # * `:error` - (String) The Amazon SNS topic that you want to notify
311
+ # when Elastic Transcoder encounters an error condition.
312
+ # * `:content_config` - (Hash) The optional ContentConfig object
313
+ # specifies information about the Amazon S3 bucket in which you want
314
+ # Elastic Transcoder to save transcoded files and playlists: which
315
+ # bucket to use, which users you want to have access to the files,
316
+ # the type of access you want users to have, and the storage class
317
+ # that you want to assign to the files. If you specify values for
318
+ # ContentConfig, you must also specify values for ThumbnailConfig. If
319
+ # you specify values for ContentConfig and ThumbnailConfig, omit the
320
+ # OutputBucket object. Bucket: The Amazon S3 bucket in which you want
321
+ # Elastic Transcoder to save transcoded files and playlists.
322
+ # Permissions (Optional): The Permissions object specifies which
323
+ # users you want to have access to transcoded files and the type of
324
+ # access you want them to have. You can grant permissions to a
325
+ # maximum of 30 users and/or predefined Amazon S3 groups. Grantee
326
+ # Type: Specify the type of value that appears in the Grantee object:
327
+ # Canonical: The value in the Grantee object is either the canonical
328
+ # user ID for an AWS account or an origin access identity for an
329
+ # Amazon CloudFront distribution. For more information about
330
+ # canonical user IDs, see Access Control List (ACL) Overview in the
331
+ # Amazon Simple Storage Service Developer Guide. For more information
332
+ # about using CloudFront origin access identities to require that
333
+ # users use CloudFront URLs instead of Amazon S3 URLs, see Using an
334
+ # Origin Access Identity to Restrict Access to Your Amazon S3
335
+ # Content. A canonical user ID is not the same as an AWS account
336
+ # number. Email: The value in the Grantee object is the registered
337
+ # email address of an AWS account. Group: The value in the Grantee
338
+ # object is one of the following predefined Amazon S3 groups:
339
+ # AllUsers, AuthenticatedUsers, or LogDelivery. Grantee: The AWS user
340
+ # or group that you want to have access to transcoded files and
341
+ # playlists. To identify the user or group, you can specify the
342
+ # canonical user ID for an AWS account, an origin access identity for
343
+ # a CloudFront distribution, the registered email address of an AWS
344
+ # account, or a predefined Amazon S3 group Access: The permission
345
+ # that you want to give to the AWS user that you specified in
346
+ # Grantee. Permissions are granted on the files that Elastic
347
+ # Transcoder adds to the bucket, including playlists and video files.
348
+ # Valid values include: READ: The grantee can read the objects and
349
+ # metadata for objects that Elastic Transcoder adds to the Amazon S3
350
+ # bucket. READ_ACP: The grantee can read the object ACL for objects
351
+ # that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP:
352
+ # The grantee can write the ACL for the objects that Elastic
353
+ # Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The grantee
354
+ # has READ, READ_ACP, and WRITE_ACP permissions for the objects that
355
+ # Elastic Transcoder adds to the Amazon S3 bucket. StorageClass: The
356
+ # Amazon S3 storage class, Standard or ReducedRedundancy, that you
357
+ # want Elastic Transcoder to assign to the video files and playlists
358
+ # 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>)
365
+ # * `:thumbnail_config` - (Hash) The ThumbnailConfig object specifies
366
+ # several values, including the Amazon S3 bucket in which you want
367
+ # Elastic Transcoder to save thumbnail files, which users you want to
368
+ # have access to the files, the type of access you want users to
369
+ # have, and the storage class that you want to assign to the files.
370
+ # If you specify values for ContentConfig, you must also specify
371
+ # values for ThumbnailConfig even if you don't want to create
372
+ # thumbnails. If you specify values for ContentConfig and
373
+ # ThumbnailConfig, omit the OutputBucket object. Bucket: The Amazon
374
+ # S3 bucket in which you want Elastic Transcoder to save thumbnail
375
+ # files. Permissions (Optional): The Permissions object specifies
376
+ # which users and/or predefined Amazon S3 groups you want to have
377
+ # access to thumbnail files, and the type of access you want them to
378
+ # have. You can grant permissions to a maximum of 30 users and/or
379
+ # predefined Amazon S3 groups. GranteeType: Specify the type of value
380
+ # that appears in the Grantee object: Canonical: The value in the
381
+ # Grantee object is either the canonical user ID for an AWS account
382
+ # or an origin access identity for an Amazon CloudFront distribution.
383
+ # A canonical user ID is not the same as an AWS account number.
384
+ # Email: The value in the Grantee object is the registered email
385
+ # address of an AWS account. Group: The value in the Grantee object
386
+ # is one of the following predefined Amazon S3 groups: AllUsers,
387
+ # AuthenticatedUsers, or LogDelivery. Grantee: The AWS user or group
388
+ # that you want to have access to thumbnail files. To identify the
389
+ # user or group, you can specify the canonical user ID for an AWS
390
+ # account, an origin access identity for a CloudFront distribution,
391
+ # the registered email address of an AWS account, or a predefined
392
+ # Amazon S3 group. Access: The permission that you want to give to
393
+ # the AWS user that you specified in Grantee. Permissions are granted
394
+ # on the thumbnail files that Elastic Transcoder adds to the bucket.
395
+ # Valid values include: READ: The grantee can read the thumbnails and
396
+ # metadata for objects that Elastic Transcoder adds to the Amazon S3
397
+ # bucket. READ_ACP: The grantee can read the object ACL for
398
+ # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
399
+ # WRITE_ACP: The grantee can write the ACL for the thumbnails that
400
+ # Elastic Transcoder adds to the Amazon S3 bucket. FULL_CONTROL: The
401
+ # grantee has READ, READ_ACP, and WRITE_ACP permissions for the
402
+ # thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
403
+ # StorageClass: The Amazon S3 storage class, Standard or
404
+ # ReducedRedundancy, that you want Elastic Transcoder to assign to
405
+ # 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>)
402
412
  # @return [Core::Response]
403
413
  # The #data method of the response object returns
404
414
  # a hash with the following structure:
@@ -434,233 +444,240 @@ module AWS
434
444
  # @!method create_preset(options = {})
435
445
  # Calls the POST CreatePreset API operation.
436
446
  # @param [Hash] options
437
- # * `:name` - (String) The name of the preset. We recommend that the name
438
- # be unique within the AWS account, but uniqueness is not enforced.
439
- # * `:description` - (String) A description of the preset.
440
- # * `:container` - (String) The container type for the output file. This
441
- # value must be mp4.
442
- # * `:video` - (Hash) A section of the request body that specifies the
443
- # video parameters.
444
- # * `:codec` - (String) The video codec for the output file. Valid
445
- # values include H.264 and vp8. You can only specify vp8 when the
446
- # container type is webm.
447
- # * `:codec_options` - (Hash) Profile The H.264 profile that you want
448
- # to use for the output file. Elastic Transcoder supports the
449
- # following profiles: baseline: The profile most commonly used for
450
- # videoconferencing and for mobile applications. main: The profile
451
- # used for standard-definition digital TV broadcasts. high: The
452
- # profile used for high-definition digital TV broadcasts and for
453
- # Blu-ray discs. Level The H.264 level that you want to use for the
454
- # output file. Elastic Transcoder supports the following levels: 1,
455
- # 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1
456
- # MaxReferenceFrames The maximum number of previously decoded frames
457
- # to use as a reference for decoding future frames. Valid values are
458
- # integers 0 through 16, but we recommend that you not use a value
459
- # greater than the following: Min(Floor(Maximum decoded picture
460
- # buffer in macroblocks * 256 / (Width in pixels * Height in
461
- # pixels)), 16) where Width in pixels and Height in pixels represent
462
- # the resolution of the output video and Maximum decoded picture
463
- # buffer in macroblocks depends on the value of the Level object. (A
464
- # macroblock is a block of pixels measuring 16x16.) Note that the
465
- # calculation for maximum decoded picture buffer, which is similar to
466
- # the calculation for maximum reference frames, uses macroblocks
467
- # instead of pixels for the width and height of the video. To
468
- # determine the value of maximum decoded picture buffer in
469
- # macroblocks, see the following list (Level - Maximum decoded
470
- # picture buffer): 1 - 396 1b - 396 1.1 - 900 1.2 - 2376 1.3 - 2376 2
471
- # - 2376 2.1 - 4752 2.2 - 8100 3 - 8100 3.1 - 18000 3.2 - 20480 4 -
472
- # 32768 4.1 - 32768
473
- # * `:keyframes_max_dist` - (String) The maximum number of frames
474
- # between key frames. Key frames are fully encoded frames; the frames
475
- # between key frames are encoded based, in part, on the content of
476
- # the key frames. The value is an integer formatted as a string;
477
- # valid values are between 1 and 100000, inclusive. A higher value
478
- # results in higher compression but may also discernibly decrease
479
- # video quality.
480
- # * `:fixed_gop` - (String) Whether to use a fixed value for FixedGOP.
481
- # Valid values are `true` and `false` : `true` : Elastic Transcoder
482
- # uses the value of KeyframesMaxDist for the distance between key
483
- # frames (the number of frames in a group of pictures, or GOP).
484
- # `false` : The distance between key frames can vary.
485
- # * `:bit_rate` - (String) The bit rate of the video stream in the
486
- # output file, in kilobits/second. Valid values depend on the values
487
- # of Level and Profile. If you specify auto, Elastic Transcoder uses
488
- # the detected bit rate of the input source. If you specify a value
489
- # other than auto, we recommend that you specify a value less than or
490
- # equal to the maximum H.264-compliant value listed for your level
491
- # and profile: Level - Maximum video bit rate in kilobits/second
492
- # (baseline and main Profile) : maximum video bit rate in
493
- # kilobits/second (high Profile) 1 - 64 : 80 1b - 128 : 160 1.1 - 192
494
- # : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 : 2500 3 - 10000 :
495
- # 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4 - 20000 : 25000 4.1
496
- # - 50000 : 62500
497
- # * `:frame_rate` - (String) The frames per second for the video stream
498
- # in the output file. Valid values include: auto, 10, 15, 23.97, 24,
499
- # 25, 29.97, 30, 60 If you specify auto, Elastic Transcoder uses the
500
- # detected frame rate of the input source. If you specify a frame
501
- # rate, we recommend that you perform the following calculation:
502
- # Frame rate = maximum recommended decoding speed in luma
503
- # samples/second / (width in pixels * height in pixels) where: width
504
- # in pixels and height in pixels represent the Resolution of the
505
- # output video. maximum recommended decoding speed in Luma
506
- # samples/second is less than or equal to the maximum value listed in
507
- # the following table, based on the value that you specified for
508
- # Level. The maximum recommended decoding speed in Luma
509
- # samples/second for each level is described in the following list
510
- # (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800 1.2 -
511
- # 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 - 5184000 3 -
512
- # 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560 4.1 - 62914560
513
- # * `:resolution` - (String) To better control resolution and aspect
514
- # ratio of output videos, we recommend that you use the values
515
- # MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
516
- # DisplayAspectRatio instead of Resolution and AspectRatio. The two
517
- # groups of settings are mutually exclusive. Do not use them
518
- # together. The width and height of the video in the output file, in
519
- # pixels. Valid values are auto and width x height: auto: Elastic
520
- # Transcoder attempts to preserve the width and height of the input
521
- # file, subject to the following rules. width x height: The width and
522
- # height of the output video in pixels. Note the following about
523
- # specifying the width and height: The width must be an even integer
524
- # between 128 and 4096, inclusive. The height must be an even integer
525
- # between 96 and 3072, inclusive. If you specify a resolution that is
526
- # less than the resolution of the input file, Elastic Transcoder
527
- # rescales the output file to the lower resolution. If you specify a
528
- # resolution that is greater than the resolution of the input file,
529
- # Elastic Transcoder rescales the output to the higher resolution. We
530
- # recommend that you specify a resolution for which the product of
531
- # width and height is less than or equal to the applicable value in
532
- # the following list (List - Max width x height value): 1 - 25344 1b
533
- # - 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 -
534
- # 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 -
535
- # 2097152 4.1 - 2097152
536
- # * `:aspect_ratio` - (String) To better control resolution and aspect
537
- # ratio of output videos, we recommend that you use the values
538
- # MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
539
- # DisplayAspectRatio instead of Resolution and AspectRatio. The two
540
- # groups of settings are mutually exclusive. Do not use them
541
- # together. The display aspect ratio of the video in the output file.
542
- # Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify
543
- # auto, Elastic Transcoder tries to preserve the aspect ratio of the
544
- # input file. If you specify an aspect ratio for the output file that
545
- # differs from aspect ratio of the input file, Elastic Transcoder
546
- # adds pillarboxing (black bars on the sides) or letterboxing (black
547
- # bars on the top and bottom) to maintain the aspect ratio of the
548
- # active region of the video.
549
- # * `:max_width` - (String) The maximum width of the output video in
550
- # pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD)
551
- # as the default value. If you specify a numeric value, enter an even
552
- # integer between 128 and 4096.
553
- # * `:max_height` - (String) The maximum height of the output video in
554
- # pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD)
555
- # as the default value. If you specify a numeric value, enter an even
556
- # integer between 96 and 3072.
557
- # * `:display_aspect_ratio` - (String) The value that Elastic
558
- # Transcoder adds to the metadata in the output file.
559
- # * `:sizing_policy` - (String) Specify one of the following values to
560
- # control scaling of the output video: Fit: Elastic Transcoder scales
561
- # the output video so it matches the value that you specified in
562
- # either MaxWidth or MaxHeight without exceeding the other value.
563
- # Fill: Elastic Transcoder scales the output video so it matches the
564
- # value that you specified in either MaxWidth or MaxHeight and
565
- # matches or exceeds the other value. Elastic Transcoder centers the
566
- # output video and then crops it in the dimension (if any) that
567
- # exceeds the maximum value. Stretch: Elastic Transcoder stretches
568
- # the output video to match the values that you specified for
569
- # MaxWidth and MaxHeight. If the relative proportions of the input
570
- # video and the output video are different, the output video will be
571
- # distorted. Keep: Elastic Transcoder does not scale the output
572
- # video. If either dimension of the input video exceeds the values
573
- # that you specified for MaxWidth and MaxHeight, Elastic Transcoder
574
- # crops the output video. ShrinkToFit: Elastic Transcoder scales the
575
- # output video down so that its dimensions match the values that you
576
- # specified for at least one of MaxWidth and MaxHeight without
577
- # exceeding either value. If you specify this option, Elastic
578
- # Transcoder does not scale the video up. ShrinkToFill: Elastic
579
- # Transcoder scales the output video down so that its dimensions
580
- # match the values that you specified for at least one of MaxWidth
581
- # and MaxHeight without dropping below either value. If you specify
582
- # this option, Elastic Transcoder does not scale the video up.
583
- # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
584
- # Elastic Transcoder may add black bars to the top and bottom and/or
585
- # left and right sides of the output video to make the total size of
586
- # the output video match the values that you specified for MaxWidth
587
- # and MaxHeight.
588
- # * `:audio` - (Hash) A section of the request body that specifies the
589
- # audio parameters.
590
- # * `:codec` - (String) The audio codec for the output file. This value
591
- # must be AAC.
592
- # * `:sample_rate` - (String) The sample rate of the audio stream in
593
- # the output file, in Hertz. Valid values include: auto, 22050,
594
- # 32000, 44100, 48000, 96000 If you specify auto, Elastic Transcoder
595
- # automatically detects the sample rate.
596
- # * `:bit_rate` - (String) The bit rate of the audio stream in the
597
- # output file, in kilobits/second. Enter an integer between 64 and
598
- # 320, inclusive.
599
- # * `:channels` - (String) The number of audio channels in the output
600
- # file. Valid values include: auto, 0, 1, 2 If you specify auto,
601
- # Elastic Transcoder automatically detects the number of channels in
602
- # the input file.
603
- # * `:thumbnails` - (Hash) A section of the request body that specifies
604
- # the thumbnail parameters, if any.
605
- # * `:format` - (String) The format of thumbnails, if any. Valid values
606
- # are jpg and png. You specify whether you want Elastic Transcoder to
607
- # create thumbnails when you create a job.
608
- # * `:interval` - (String) The number of seconds between thumbnails.
609
- # Specify an integer value.
610
- # * `:resolution` - (String) To better control resolution and aspect
611
- # ratio of thumbnails, we recommend that you use the values MaxWidth,
612
- # MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution
613
- # and AspectRatio. The two groups of settings are mutually exclusive.
614
- # Do not use them together. The width and height of thumbnail files
615
- # in pixels. Specify a value in the format width x height where both
616
- # values are even integers. The values cannot exceed the width and
617
- # height that you specified in the Video:Resolution object.
618
- # * `:aspect_ratio` - (String) To better control resolution and aspect
619
- # ratio of thumbnails, we recommend that you use the values MaxWidth,
620
- # MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution
621
- # and AspectRatio. The two groups of settings are mutually exclusive.
622
- # Do not use them together. The aspect ratio of thumbnails. Valid
623
- # values include: auto, 1:1, 4:3, 3:2, 16:9 If you specify auto,
624
- # Elastic Transcoder tries to preserve the aspect ratio of the video
625
- # in the output file.
626
- # * `:max_width` - (String) The maximum width of thumbnails in pixels.
627
- # If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the
628
- # default value. If you specify a numeric value, enter an even
629
- # integer between 32 and 4096.
630
- # * `:max_height` - (String) The maximum height of thumbnails in
631
- # pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD)
632
- # as the default value. If you specify a numeric value, enter an even
633
- # integer between 32 and 3072.
634
- # * `:sizing_policy` - (String) Specify one of the following values to
635
- # control scaling of thumbnails: Fit: Elastic Transcoder scales
636
- # thumbnails so they match the value that you specified in thumbnail
637
- # MaxWidth or MaxHeight settings without exceeding the other value.
638
- # Fill: Elastic Transcoder scales thumbnails so they match the value
639
- # that you specified in thumbnail MaxWidth or MaxHeight settings and
640
- # matches or exceeds the other value. Elastic Transcoder centers the
641
- # image in thumbnails and then crops in the dimension (if any) that
642
- # exceeds the maximum value. Stretch: Elastic Transcoder stretches
643
- # thumbnails to match the values that you specified for thumbnail
644
- # MaxWidth and MaxHeight settings. If the relative proportions of the
645
- # input video and thumbnails are different, the thumbnails will be
646
- # distorted. Keep: Elastic Transcoder does not scale thumbnails. If
647
- # either dimension of the input video exceeds the values that you
648
- # specified for thumbnail MaxWidth and MaxHeight settings, Elastic
649
- # Transcoder crops the thumbnails. ShrinkToFit: Elastic Transcoder
650
- # scales thumbnails down so that their dimensions match the values
651
- # that you specified for at least one of thumbnail MaxWidth and
652
- # MaxHeight without exceeding either value. If you specify this
653
- # option, Elastic Transcoder does not scale thumbnails up.
654
- # ShrinkToFill: Elastic Transcoder scales thumbnails down so that
655
- # their dimensions match the values that you specified for at least
656
- # one of MaxWidth and MaxHeight without dropping below either value.
657
- # If you specify this option, Elastic Transcoder does not scale
658
- # thumbnails up.
659
- # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
660
- # Elastic Transcoder may add black bars to the top and bottom and/or
661
- # left and right sides of thumbnails to make the total size of the
662
- # thumbnails match the values that you specified for thumbnail
663
- # MaxWidth and MaxHeight settings.
447
+ #
448
+ # * `:name` - (String) The name of the preset. We recommend that the
449
+ # name be unique within the AWS account, but uniqueness is not
450
+ # enforced.
451
+ # * `:description` - (String) A description of the preset.
452
+ # * `:container` - (String) The container type for the output file.
453
+ # This value must be mp4.
454
+ # * `:video` - (Hash) A section of the request body that specifies the
455
+ # video parameters.
456
+ # * `:codec` - (String) The video codec for the output file. Valid
457
+ # values include H.264 and vp8. You can only specify vp8 when the
458
+ # container type is webm.
459
+ # * `:codec_options` - (Hash) Profile The H.264 profile that you want
460
+ # to use for the output file. Elastic Transcoder supports the
461
+ # following profiles: baseline: The profile most commonly used for
462
+ # videoconferencing and for mobile applications. main: The profile
463
+ # used for standard-definition digital TV broadcasts. high: The
464
+ # 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
485
+ # * `:keyframes_max_dist` - (String) The maximum number of frames
486
+ # between key frames. Key frames are fully encoded frames; the
487
+ # frames between key frames are encoded based, in part, on the
488
+ # 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.
492
+ # * `:fixed_gop` - (String) Whether to use a fixed value for
493
+ # FixedGOP. Valid values are `true` and `false` : `true` : Elastic
494
+ # Transcoder uses the value of KeyframesMaxDist for the distance
495
+ # between key frames (the number of frames in a group of pictures,
496
+ # or GOP). `false` : The distance between key frames can vary.
497
+ # * `:bit_rate` - (String) The bit rate of the video stream in the
498
+ # output file, in kilobits/second. Valid values depend on the
499
+ # values of Level and Profile. If you specify auto, Elastic
500
+ # Transcoder uses the detected bit rate of the input source. If you
501
+ # specify a value other than auto, we recommend that you specify a
502
+ # value less than or equal to the maximum H.264-compliant value
503
+ # listed for your level and profile: Level - Maximum video bit rate
504
+ # in kilobits/second (baseline and main Profile) : maximum video
505
+ # bit rate in kilobits/second (high Profile) 1 - 64 : 80 1b - 128 :
506
+ # 160 1.1 - 192 : 240 1.2 - 384 : 480 1.3 - 768 : 960 2 - 2000 :
507
+ # 2500 3 - 10000 : 12500 3.1 - 14000 : 17500 3.2 - 20000 : 25000 4
508
+ # - 20000 : 25000 4.1 - 50000 : 62500
509
+ # * `:frame_rate` - (String) The frames per second for the video
510
+ # stream in the output file. Valid values include: auto, 10, 15,
511
+ # 23.97, 24, 25, 29.97, 30, 60 If you specify auto, Elastic
512
+ # Transcoder uses the detected frame rate of the input source. If
513
+ # you specify a frame rate, we recommend that you perform the
514
+ # following calculation: Frame rate = maximum recommended decoding
515
+ # speed in luma samples/second / (width in pixels * height in
516
+ # pixels) where: width in pixels and height in pixels represent the
517
+ # Resolution of the output video. maximum recommended decoding
518
+ # speed in Luma samples/second is less than or equal to the maximum
519
+ # value listed in the following table, based on the value that you
520
+ # specified for Level. The maximum recommended decoding speed in
521
+ # Luma samples/second for each level is described in the following
522
+ # list (Level - Decoding speed): 1 - 380160 1b - 380160 1.1 - 76800
523
+ # 1.2 - 1536000 1.3 - 3041280 2 - 3041280 2.1 - 5068800 2.2 -
524
+ # 5184000 3 - 10368000 3.1 - 27648000 3.2 - 55296000 4 - 62914560
525
+ # 4.1 - 62914560
526
+ # * `:resolution` - (String) To better control resolution and aspect
527
+ # ratio of output videos, we recommend that you use the values
528
+ # MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
529
+ # DisplayAspectRatio instead of Resolution and AspectRatio. The two
530
+ # groups of settings are mutually exclusive. Do not use them
531
+ # together. The width and height of the video in the output file,
532
+ # in pixels. Valid values are auto and width x height: auto:
533
+ # Elastic Transcoder attempts to preserve the width and height of
534
+ # the input file, subject to the following rules. width x height:
535
+ # The width and height of the output video in pixels. Note the
536
+ # following about specifying the width and height: The width must
537
+ # be an even integer between 128 and 4096, inclusive. The height
538
+ # must be an even integer between 96 and 3072, inclusive. If you
539
+ # specify a resolution that is less than the resolution of the
540
+ # input file, Elastic Transcoder rescales the output file to the
541
+ # lower resolution. If you specify a resolution that is greater
542
+ # than the resolution of the input file, Elastic Transcoder
543
+ # rescales the output to the higher resolution. We recommend that
544
+ # you specify a resolution for which the product of width and
545
+ # height is less than or equal to the applicable value in the
546
+ # following list (List - Max width x height value): 1 - 25344 1b -
547
+ # 25344 1.1 - 101376 1.2 - 101376 1.3 - 101376 2 - 101376 2.1 -
548
+ # 202752 2.2 - 404720 3 - 404720 3.1 - 921600 3.2 - 1310720 4 -
549
+ # 2097152 4.1 - 2097152
550
+ # * `:aspect_ratio` - (String) To better control resolution and
551
+ # aspect ratio of output videos, we recommend that you use the
552
+ # values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
553
+ # DisplayAspectRatio instead of Resolution and AspectRatio. The two
554
+ # groups of settings are mutually exclusive. Do not use them
555
+ # together. The display aspect ratio of the video in the output
556
+ # file. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If you
557
+ # specify auto, Elastic Transcoder tries to preserve the aspect
558
+ # ratio of the input file. If you specify an aspect ratio for the
559
+ # output file that differs from aspect ratio of the input file,
560
+ # Elastic Transcoder adds pillarboxing (black bars on the sides) or
561
+ # letterboxing (black bars on the top and bottom) to maintain the
562
+ # aspect ratio of the active region of the video.
563
+ # * `:max_width` - (String) The maximum width of the output video in
564
+ # pixels. If you specify auto, Elastic Transcoder uses 1920 (Full
565
+ # HD) as the default value. If you specify a numeric value, enter
566
+ # an even integer between 128 and 4096.
567
+ # * `:max_height` - (String) The maximum height of the output video
568
+ # in pixels. If you specify auto, Elastic Transcoder uses 1080
569
+ # (Full HD) as the default value. If you specify a numeric value,
570
+ # enter an even integer between 96 and 3072.
571
+ # * `:display_aspect_ratio` - (String) The value that Elastic
572
+ # Transcoder adds to the metadata in the output file.
573
+ # * `:sizing_policy` - (String) Specify one of the following values
574
+ # to control scaling of the output video: Fit: Elastic Transcoder
575
+ # scales the output video so it matches the value that you
576
+ # specified in either MaxWidth or MaxHeight without exceeding the
577
+ # other value. Fill: Elastic Transcoder scales the output video so
578
+ # it matches the value that you specified in either MaxWidth or
579
+ # MaxHeight and matches or exceeds the other value. Elastic
580
+ # Transcoder centers the output video and then crops it in the
581
+ # dimension (if any) that exceeds the maximum value. Stretch:
582
+ # Elastic Transcoder stretches the output video to match the values
583
+ # that you specified for MaxWidth and MaxHeight. If the relative
584
+ # proportions of the input video and the output video are
585
+ # different, the output video will be distorted. Keep: Elastic
586
+ # Transcoder does not scale the output video. If either dimension
587
+ # of the input video exceeds the values that you specified for
588
+ # MaxWidth and MaxHeight, Elastic Transcoder crops the output
589
+ # video. ShrinkToFit: Elastic Transcoder scales the output video
590
+ # down so that its dimensions match the values that you specified
591
+ # for at least one of MaxWidth and MaxHeight without exceeding
592
+ # either value. If you specify this option, Elastic Transcoder does
593
+ # not scale the video up. ShrinkToFill: Elastic Transcoder scales
594
+ # the output video down so that its dimensions match the values
595
+ # that you specified for at least one of MaxWidth and MaxHeight
596
+ # without dropping below either value. If you specify this option,
597
+ # Elastic Transcoder does not scale the video up.
598
+ # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
599
+ # Elastic Transcoder may add black bars to the top and bottom
600
+ # and/or left and right sides of the output video to make the total
601
+ # size of the output video match the values that you specified for
602
+ # MaxWidth and MaxHeight.
603
+ # * `:audio` - (Hash) A section of the request body that specifies the
604
+ # audio parameters.
605
+ # * `:codec` - (String) The audio codec for the output file. This
606
+ # value must be AAC.
607
+ # * `:sample_rate` - (String) The sample rate of the audio stream in
608
+ # the output file, in Hertz. Valid values include: auto, 22050,
609
+ # 32000, 44100, 48000, 96000 If you specify auto, Elastic
610
+ # Transcoder automatically detects the sample rate.
611
+ # * `:bit_rate` - (String) The bit rate of the audio stream in the
612
+ # output file, in kilobits/second. Enter an integer between 64 and
613
+ # 320, inclusive.
614
+ # * `:channels` - (String) The number of audio channels in the output
615
+ # file. Valid values include: auto, 0, 1, 2 If you specify auto,
616
+ # Elastic Transcoder automatically detects the number of channels
617
+ # in the input file.
618
+ # * `:thumbnails` - (Hash) A section of the request body that specifies
619
+ # the thumbnail parameters, if any.
620
+ # * `:format` - (String) The format of thumbnails, if any. Valid
621
+ # values are jpg and png. You specify whether you want Elastic
622
+ # Transcoder to create thumbnails when you create a job.
623
+ # * `:interval` - (String) The number of seconds between thumbnails.
624
+ # Specify an integer value.
625
+ # * `:resolution` - (String) To better control resolution and aspect
626
+ # ratio of thumbnails, we recommend that you use the values
627
+ # MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of
628
+ # Resolution and AspectRatio. The two groups of settings are
629
+ # mutually exclusive. Do not use them together. The width and
630
+ # height of thumbnail files in pixels. Specify a value in the
631
+ # format width x height where both values are even integers. The
632
+ # values cannot exceed the width and height that you specified in
633
+ # the Video:Resolution object.
634
+ # * `:aspect_ratio` - (String) To better control resolution and
635
+ # aspect ratio of thumbnails, we recommend that you use the values
636
+ # MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of
637
+ # Resolution and AspectRatio. The two groups of settings are
638
+ # mutually exclusive. Do not use them together. The aspect ratio of
639
+ # thumbnails. Valid values include: auto, 1:1, 4:3, 3:2, 16:9 If
640
+ # you specify auto, Elastic Transcoder tries to preserve the aspect
641
+ # ratio of the video in the output file.
642
+ # * `:max_width` - (String) The maximum width of thumbnails in
643
+ # pixels. If you specify auto, Elastic Transcoder uses 1920 (Full
644
+ # HD) as the default value. If you specify a numeric value, enter
645
+ # an even integer between 32 and 4096.
646
+ # * `:max_height` - (String) The maximum height of thumbnails in
647
+ # pixels. If you specify auto, Elastic Transcoder uses 1080 (Full
648
+ # HD) as the default value. If you specify a numeric value, enter
649
+ # an even integer between 32 and 3072.
650
+ # * `:sizing_policy` - (String) Specify one of the following values
651
+ # to control scaling of thumbnails: Fit: Elastic Transcoder scales
652
+ # thumbnails so they match the value that you specified in
653
+ # thumbnail MaxWidth or MaxHeight settings without exceeding the
654
+ # other value. Fill: Elastic Transcoder scales thumbnails so they
655
+ # match the value that you specified in thumbnail MaxWidth or
656
+ # MaxHeight settings and matches or exceeds the other value.
657
+ # Elastic Transcoder centers the image in thumbnails and then crops
658
+ # in the dimension (if any) that exceeds the maximum value.
659
+ # Stretch: Elastic Transcoder stretches thumbnails to match the
660
+ # values that you specified for thumbnail MaxWidth and MaxHeight
661
+ # settings. If the relative proportions of the input video and
662
+ # thumbnails are different, the thumbnails will be distorted. Keep:
663
+ # Elastic Transcoder does not scale thumbnails. If either dimension
664
+ # of the input video exceeds the values that you specified for
665
+ # thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder
666
+ # crops the thumbnails. ShrinkToFit: Elastic Transcoder scales
667
+ # thumbnails down so that their dimensions match the values that
668
+ # you specified for at least one of thumbnail MaxWidth and
669
+ # MaxHeight without exceeding either value. If you specify this
670
+ # option, Elastic Transcoder does not scale thumbnails up.
671
+ # ShrinkToFill: Elastic Transcoder scales thumbnails down so that
672
+ # their dimensions match the values that you specified for at least
673
+ # one of MaxWidth and MaxHeight without dropping below either
674
+ # value. If you specify this option, Elastic Transcoder does not
675
+ # scale thumbnails up.
676
+ # * `:padding_policy` - (String) When you set PaddingPolicy to Pad,
677
+ # Elastic Transcoder may add black bars to the top and bottom
678
+ # and/or left and right sides of thumbnails to make the total size
679
+ # of the thumbnails match the values that you specified for
680
+ # thumbnail MaxWidth and MaxHeight settings.
664
681
  # @return [Core::Response]
665
682
  # The #data method of the response object returns
666
683
  # a hash with the following structure:
@@ -704,28 +721,31 @@ module AWS
704
721
  # @!method delete_pipeline(options = {})
705
722
  # Calls the DELETE DeletePipeline API operation.
706
723
  # @param [Hash] options
707
- # * `:id` - *required* - (String) The identifier of the pipeline that you
708
- # want to delete.
724
+ #
725
+ # * `:id` - *required* - (String) The identifier of the pipeline that
726
+ # you want to delete.
709
727
  # @return [Core::Response]
710
728
 
711
729
  # @!method delete_preset(options = {})
712
730
  # Calls the DELETE DeletePreset API operation.
713
731
  # @param [Hash] options
714
- # * `:id` - *required* - (String) The identifier of the preset for which
715
- # you want to get detailed information.
732
+ #
733
+ # * `:id` - *required* - (String) The identifier of the preset for
734
+ # which you want to get detailed information.
716
735
  # @return [Core::Response]
717
736
 
718
737
  # @!method list_jobs_by_pipeline(options = {})
719
738
  # Calls the GET ListJobsByPipeline API operation.
720
739
  # @param [Hash] options
721
- # * `:pipeline_id` - *required* - (String) The ID of the pipeline for
722
- # which you want to get job information.
723
- # * `:ascending` - (String) To list jobs in chronological order by the
724
- # date and time that they were submitted, enter `true` . To list jobs
725
- # in reverse chronological order, enter `false` .
726
- # * `:page_token` - (String) When Elastic Transcoder returns more than
727
- # one page of results, use pageToken in subsequent GET requests to get
728
- # each successive page of results.
740
+ #
741
+ # * `:pipeline_id` - *required* - (String) The ID of the pipeline for
742
+ # which you want to get job information.
743
+ # * `:ascending` - (String) To list jobs in chronological order by the
744
+ # date and time that they were submitted, enter `true` . To list jobs
745
+ # in reverse chronological order, enter `false` .
746
+ # * `:page_token` - (String) When Elastic Transcoder returns more than
747
+ # one page of results, use pageToken in subsequent GET requests to
748
+ # get each successive page of results.
729
749
  # @return [Core::Response]
730
750
  # The #data method of the response object returns
731
751
  # a hash with the following structure:
@@ -777,16 +797,17 @@ module AWS
777
797
  # @!method list_jobs_by_status(options = {})
778
798
  # Calls the GET ListJobsByStatus API operation.
779
799
  # @param [Hash] options
780
- # * `:status` - *required* - (String) To get information about all of the
781
- # jobs associated with the current AWS account that have a given
782
- # status, specify the following status: Submitted, Progressing,
783
- # Complete, Canceled, or Error.
784
- # * `:ascending` - (String) To list jobs in chronological order by the
785
- # date and time that they were submitted, enter `true` . To list jobs
786
- # in reverse chronological order, enter `false` .
787
- # * `:page_token` - (String) When Elastic Transcoder returns more than
788
- # one page of results, use pageToken in subsequent GET requests to get
789
- # each successive page of results.
800
+ #
801
+ # * `:status` - *required* - (String) To get information about all of
802
+ # the jobs associated with the current AWS account that have a given
803
+ # status, specify the following status: Submitted, Progressing,
804
+ # Complete, Canceled, or Error.
805
+ # * `:ascending` - (String) To list jobs in chronological order by the
806
+ # date and time that they were submitted, enter `true` . To list jobs
807
+ # in reverse chronological order, enter `false` .
808
+ # * `:page_token` - (String) When Elastic Transcoder returns more than
809
+ # one page of results, use pageToken in subsequent GET requests to
810
+ # get each successive page of results.
790
811
  # @return [Core::Response]
791
812
  # The #data method of the response object returns
792
813
  # a hash with the following structure:
@@ -838,6 +859,7 @@ module AWS
838
859
  # @!method list_pipelines(options = {})
839
860
  # Calls the GET ListPipelines API operation.
840
861
  # @param [Hash] options
862
+ #
841
863
  # @return [Core::Response]
842
864
  # The #data method of the response object returns
843
865
  # a hash with the following structure:
@@ -873,6 +895,7 @@ module AWS
873
895
  # @!method list_presets(options = {})
874
896
  # Calls the GET ListPresets API operation.
875
897
  # @param [Hash] options
898
+ #
876
899
  # @return [Core::Response]
877
900
  # The #data method of the response object returns
878
901
  # a hash with the following structure:
@@ -915,8 +938,9 @@ module AWS
915
938
  # @!method read_job(options = {})
916
939
  # Calls the GET ReadJob API operation.
917
940
  # @param [Hash] options
918
- # * `:id` - *required* - (String) The identifier of the job for which you
919
- # want to get detailed information.
941
+ #
942
+ # * `:id` - *required* - (String) The identifier of the job for which
943
+ # you want to get detailed information.
920
944
  # @return [Core::Response]
921
945
  # The #data method of the response object returns
922
946
  # a hash with the following structure:
@@ -967,7 +991,9 @@ module AWS
967
991
  # @!method read_pipeline(options = {})
968
992
  # Calls the GET ReadPipeline API operation.
969
993
  # @param [Hash] options
970
- # * `:id` - *required* - (String) The identifier of the pipeline to read.
994
+ #
995
+ # * `:id` - *required* - (String) The identifier of the pipeline to
996
+ # read.
971
997
  # @return [Core::Response]
972
998
  # The #data method of the response object returns
973
999
  # a hash with the following structure:
@@ -1003,8 +1029,9 @@ module AWS
1003
1029
  # @!method read_preset(options = {})
1004
1030
  # Calls the GET ReadPreset API operation.
1005
1031
  # @param [Hash] options
1006
- # * `:id` - *required* - (String) The identifier of the preset for which
1007
- # you want to get detailed information.
1032
+ #
1033
+ # * `:id` - *required* - (String) The identifier of the preset for
1034
+ # which you want to get detailed information.
1008
1035
  # @return [Core::Response]
1009
1036
  # The #data method of the response object returns
1010
1037
  # a hash with the following structure:
@@ -1047,16 +1074,18 @@ module AWS
1047
1074
  # @!method test_role(options = {})
1048
1075
  # Calls the POST TestRole API operation.
1049
1076
  # @param [Hash] options
1050
- # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
1051
- # that you want Elastic Transcoder to test.
1052
- # * `:input_bucket` - (String) The Amazon S3 bucket that contains media
1053
- # files to be transcoded. The action attempts to read from this bucket.
1054
- # * `:output_bucket` - (String) The Amazon S3 bucket that Elastic
1055
- # Transcoder will write transcoded media files to. The action attempts
1056
- # to read from this bucket.
1057
- # * `:topics` - (Array<String>) The ARNs of one or more Amazon Simple
1058
- # Notification Service (Amazon SNS) topics that you want the action to
1059
- # send a test notification to.
1077
+ #
1078
+ # * `:role` - (String) The IAM Amazon Resource Name (ARN) for the role
1079
+ # that you want Elastic Transcoder to test.
1080
+ # * `:input_bucket` - (String) The Amazon S3 bucket that contains media
1081
+ # files to be transcoded. The action attempts to read from this
1082
+ # bucket.
1083
+ # * `:output_bucket` - (String) The Amazon S3 bucket that Elastic
1084
+ # Transcoder will write transcoded media files to. The action
1085
+ # attempts to read from this bucket.
1086
+ # * `:topics` - (Array<String>) The ARNs of one or more Amazon Simple
1087
+ # Notification Service (Amazon SNS) topics that you want the action
1088
+ # to send a test notification to.
1060
1089
  # @return [Core::Response]
1061
1090
  # The #data method of the response object returns
1062
1091
  # a hash with the following structure:
@@ -1067,34 +1096,35 @@ module AWS
1067
1096
  # @!method update_pipeline(options = {})
1068
1097
  # Calls the PUT UpdatePipeline API operation.
1069
1098
  # @param [Hash] options
1070
- # * `:id` - *required* - (String)
1071
- # * `:name` - (String)
1072
- # * `:input_bucket` - (String)
1073
- # * `:role` - (String)
1074
- # * `:notifications` - (Hash)
1075
- # * `:progressing` - (String) The Amazon Simple Notification Service
1076
- # (Amazon SNS) topic that you want to notify when Elastic Transcoder
1077
- # has started to process the job.
1078
- # * `:completed` - (String) The Amazon SNS topic that you want to
1079
- # notify when Elastic Transcoder has finished processing the job.
1080
- # * `:warning` - (String) The Amazon SNS topic that you want to notify
1081
- # when Elastic Transcoder encounters a warning condition.
1082
- # * `:error` - (String) The Amazon SNS topic that you want to notify
1083
- # when Elastic Transcoder encounters an error condition.
1084
- # * `:content_config` - (Hash)
1085
- # * `:bucket` - (String)
1086
- # * `:storage_class` - (String)
1087
- # * `:permissions` - (Array<Hash>)
1088
- # * `:grantee_type` - (String)
1089
- # * `:grantee` - (String)
1090
- # * `:access` - (Array<String>)
1091
- # * `:thumbnail_config` - (Hash)
1092
- # * `:bucket` - (String)
1093
- # * `:storage_class` - (String)
1094
- # * `:permissions` - (Array<Hash>)
1095
- # * `:grantee_type` - (String)
1096
- # * `:grantee` - (String)
1097
- # * `:access` - (Array<String>)
1099
+ #
1100
+ # * `:id` - *required* - (String)
1101
+ # * `:name` - (String)
1102
+ # * `:input_bucket` - (String)
1103
+ # * `:role` - (String)
1104
+ # * `:notifications` - (Hash)
1105
+ # * `:progressing` - (String) The Amazon Simple Notification Service
1106
+ # (Amazon SNS) topic that you want to notify when Elastic
1107
+ # Transcoder has started to process the job.
1108
+ # * `:completed` - (String) The Amazon SNS topic that you want to
1109
+ # notify when Elastic Transcoder has finished processing the job.
1110
+ # * `:warning` - (String) The Amazon SNS topic that you want to
1111
+ # notify when Elastic Transcoder encounters a warning condition.
1112
+ # * `:error` - (String) The Amazon SNS topic that you want to notify
1113
+ # 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>)
1098
1128
  # @return [Core::Response]
1099
1129
  # The #data method of the response object returns
1100
1130
  # a hash with the following structure:
@@ -1130,34 +1160,35 @@ module AWS
1130
1160
  # @!method update_pipeline_notifications(options = {})
1131
1161
  # Calls the POST UpdatePipelineNotifications API operation.
1132
1162
  # @param [Hash] options
1133
- # * `:id` - *required* - (String) The identifier of the pipeline for
1134
- # which you want to change notification settings.
1135
- # * `:notifications` - (Hash) The topic ARN for the Amazon Simple
1136
- # Notification Service (Amazon SNS) topic that you want to notify to
1137
- # report job status. To receive notifications, you must also subscribe
1138
- # to the new topic in the Amazon SNS console. Progressing: The topic
1139
- # ARN for the Amazon Simple Notification Service (Amazon SNS) topic
1140
- # that you want to notify when Elastic Transcoder has started to
1141
- # process jobs that are added to this pipeline. This is the ARN that
1142
- # Amazon SNS returned when you created the topic. Completed: The topic
1143
- # ARN for the Amazon SNS topic that you want to notify when Elastic
1144
- # Transcoder has finished processing a job. This is the ARN that Amazon
1145
- # SNS returned when you created the topic. Warning: The topic ARN for
1146
- # the Amazon SNS topic that you want to notify when Elastic Transcoder
1147
- # encounters a warning condition. This is the ARN that Amazon SNS
1148
- # returned when you created the topic. Error: The topic ARN for the
1149
- # Amazon SNS topic that you want to notify when Elastic Transcoder
1150
- # encounters an error condition. This is the ARN that Amazon SNS
1151
- # returned when you created the topic.
1152
- # * `:progressing` - (String) The Amazon Simple Notification Service
1153
- # (Amazon SNS) topic that you want to notify when Elastic Transcoder
1154
- # has started to process the job.
1155
- # * `:completed` - (String) The Amazon SNS topic that you want to
1156
- # notify when Elastic Transcoder has finished processing the job.
1157
- # * `:warning` - (String) The Amazon SNS topic that you want to notify
1158
- # when Elastic Transcoder encounters a warning condition.
1159
- # * `:error` - (String) The Amazon SNS topic that you want to notify
1160
- # when Elastic Transcoder encounters an error condition.
1163
+ #
1164
+ # * `:id` - *required* - (String) The identifier of the pipeline for
1165
+ # which you want to change notification settings.
1166
+ # * `:notifications` - (Hash) The topic ARN for the Amazon Simple
1167
+ # Notification Service (Amazon SNS) topic that you want to notify to
1168
+ # report job status. To receive notifications, you must also
1169
+ # subscribe to the new topic in the Amazon SNS console. Progressing:
1170
+ # The topic ARN for the Amazon Simple Notification Service (Amazon
1171
+ # SNS) topic that you want to notify when Elastic Transcoder has
1172
+ # started to process jobs that are added to this pipeline. This is
1173
+ # the ARN that Amazon SNS returned when you created the topic.
1174
+ # Completed: The topic ARN for the Amazon SNS topic that you want to
1175
+ # notify when Elastic Transcoder has finished processing a job. This
1176
+ # is the ARN that Amazon SNS returned when you created the topic.
1177
+ # Warning: The topic ARN for the Amazon SNS topic that you want to
1178
+ # notify when Elastic Transcoder encounters a warning condition. This
1179
+ # is the ARN that Amazon SNS returned when you created the topic.
1180
+ # Error: The topic ARN for the Amazon SNS topic that you want to
1181
+ # notify when Elastic Transcoder encounters an error condition. This
1182
+ # is the ARN that Amazon SNS returned when you created the topic.
1183
+ # * `:progressing` - (String) The Amazon Simple Notification Service
1184
+ # (Amazon SNS) topic that you want to notify when Elastic
1185
+ # Transcoder has started to process the job.
1186
+ # * `:completed` - (String) The Amazon SNS topic that you want to
1187
+ # notify when Elastic Transcoder has finished processing the job.
1188
+ # * `:warning` - (String) The Amazon SNS topic that you want to
1189
+ # notify when Elastic Transcoder encounters a warning condition.
1190
+ # * `:error` - (String) The Amazon SNS topic that you want to notify
1191
+ # when Elastic Transcoder encounters an error condition.
1161
1192
  # @return [Core::Response]
1162
1193
  # The #data method of the response object returns
1163
1194
  # a hash with the following structure:
@@ -1193,11 +1224,12 @@ module AWS
1193
1224
  # @!method update_pipeline_status(options = {})
1194
1225
  # Calls the POST UpdatePipelineStatus API operation.
1195
1226
  # @param [Hash] options
1196
- # * `:id` - *required* - (String) The identifier of the pipeline to
1197
- # update.
1198
- # * `:status` - (String) The desired status of the pipeline: Active: The
1199
- # pipeline is processing jobs. Paused: The pipeline is not currently
1200
- # processing jobs.
1227
+ #
1228
+ # * `:id` - *required* - (String) The identifier of the pipeline to
1229
+ # update.
1230
+ # * `:status` - (String) The desired status of the pipeline: Active:
1231
+ # The pipeline is processing jobs. Paused: The pipeline is not
1232
+ # currently processing jobs.
1201
1233
  # @return [Core::Response]
1202
1234
  # The #data method of the response object returns
1203
1235
  # a hash with the following structure: