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.
- data/lib/aws/auto_scaling/client.rb +34 -0
- data/lib/aws/cloud_formation/client.rb +13 -0
- data/lib/aws/cloud_front/client.rb +722 -685
- data/lib/aws/cloud_search/client.rb +20 -0
- data/lib/aws/cloud_watch/client.rb +11 -0
- data/lib/aws/data_pipeline/client.rb +16 -0
- data/lib/aws/direct_connect/client.rb +11 -0
- data/lib/aws/ec2/client.rb +149 -0
- data/lib/aws/ec2/instance.rb +7 -4
- data/lib/aws/elastic_beanstalk/client.rb +29 -0
- data/lib/aws/elastic_transcoder/client.rb +663 -631
- data/lib/aws/elasticache/client.rb +26 -0
- data/lib/aws/elb/client.rb +23 -0
- data/lib/aws/emr/client.rb +14 -22
- data/lib/aws/glacier/client.rb +96 -77
- data/lib/aws/iam/client.rb +71 -11
- data/lib/aws/import_export/client.rb +5 -0
- data/lib/aws/ops_works/client.rb +43 -0
- data/lib/aws/rds/client.rb +52 -0
- data/lib/aws/redshift/client.rb +33 -0
- data/lib/aws/route_53/client.rb +231 -217
- data/lib/aws/s3/client.rb +5 -1
- data/lib/aws/s3/s3_object.rb +0 -1
- data/lib/aws/simple_db/client.rb +10 -0
- data/lib/aws/simple_email_service/client.rb +18 -0
- data/lib/aws/simple_workflow/client.rb +31 -0
- data/lib/aws/sns/client.rb +154 -119
- data/lib/aws/sns/request.rb +7 -1
- data/lib/aws/sqs/client.rb +15 -0
- data/lib/aws/sqs/queue.rb +2 -2
- data/lib/aws/storage_gateway/client.rb +35 -0
- data/lib/aws/sts/client.rb +4 -0
- data/lib/aws/support/client.rb +24 -0
- data/lib/aws/version.rb +1 -1
- metadata +2 -2
data/lib/aws/ec2/instance.rb
CHANGED
@@ -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)
|
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
|
-
#
|
42
|
-
#
|
43
|
-
#
|
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
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
# ratio of the input file
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
# input file is interlaced
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
# type
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
#
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
#
|
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
|
-
#
|
253
|
-
# name
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
# * `:
|
355
|
-
# * `:
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
# * `:
|
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
|
-
#
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
444
|
-
# * `:
|
445
|
-
#
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
514
|
-
#
|
515
|
-
#
|
516
|
-
#
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
# * `:
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
644
|
-
#
|
645
|
-
#
|
646
|
-
#
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
650
|
-
#
|
651
|
-
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
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
|
-
#
|
708
|
-
#
|
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
|
-
#
|
715
|
-
#
|
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
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
#
|
726
|
-
#
|
727
|
-
#
|
728
|
-
#
|
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
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
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
|
-
#
|
919
|
-
#
|
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
|
-
#
|
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
|
-
#
|
1007
|
-
#
|
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
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
#
|
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
|
-
#
|
1071
|
-
#
|
1072
|
-
#
|
1073
|
-
#
|
1074
|
-
#
|
1075
|
-
# * `:
|
1076
|
-
#
|
1077
|
-
#
|
1078
|
-
#
|
1079
|
-
#
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
#
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
# * `:
|
1086
|
-
#
|
1087
|
-
#
|
1088
|
-
# * `:
|
1089
|
-
#
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
# * `:
|
1093
|
-
#
|
1094
|
-
#
|
1095
|
-
# * `:
|
1096
|
-
#
|
1097
|
-
#
|
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
|
-
#
|
1134
|
-
#
|
1135
|
-
#
|
1136
|
-
#
|
1137
|
-
#
|
1138
|
-
#
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1142
|
-
#
|
1143
|
-
#
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
#
|
1148
|
-
#
|
1149
|
-
#
|
1150
|
-
#
|
1151
|
-
#
|
1152
|
-
#
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
#
|
1158
|
-
#
|
1159
|
-
#
|
1160
|
-
#
|
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
|
-
#
|
1197
|
-
#
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
#
|
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:
|