forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
3608 lines (3125 loc) · 155 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
76
77
78
79
80
81
82
83
84
85
86
87
88
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
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
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package elastictranscoder provides a client for Amazon Elastic Transcoder.
package elastictranscoder
import (
"github.com/aws/aws-sdk-go/aws"
)
const opCancelJob = "CancelJob"
// CancelJobRequest generates a request for the CancelJob operation.
func (c *ElasticTranscoder) CancelJobRequest(input *CancelJobInput) (req *aws.Request, output *CancelJobOutput) {
op := &aws.Operation{
Name: opCancelJob,
HTTPMethod: "DELETE",
HTTPPath: "/2012-09-25/jobs/{Id}",
}
if input == nil {
input = &CancelJobInput{}
}
req = c.newRequest(op, input, output)
output = &CancelJobOutput{}
req.Data = output
return
}
// The CancelJob operation cancels an unfinished job.
//
// You can only cancel a job that has a status of Submitted. To prevent a pipeline
// from starting to process a job while you're getting the job identifier, use
// UpdatePipelineStatus to temporarily pause the pipeline.
func (c *ElasticTranscoder) CancelJob(input *CancelJobInput) (*CancelJobOutput, error) {
req, out := c.CancelJobRequest(input)
err := req.Send()
return out, err
}
const opCreateJob = "CreateJob"
// CreateJobRequest generates a request for the CreateJob operation.
func (c *ElasticTranscoder) CreateJobRequest(input *CreateJobInput) (req *aws.Request, output *CreateJobResponse) {
op := &aws.Operation{
Name: opCreateJob,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/jobs",
}
if input == nil {
input = &CreateJobInput{}
}
req = c.newRequest(op, input, output)
output = &CreateJobResponse{}
req.Data = output
return
}
// When you create a job, Elastic Transcoder returns JSON data that includes
// the values that you specified plus information about the job that is created.
//
// If you have specified more than one output for your jobs (for example, one
// output for the Kindle Fire and another output for the Apple iPhone 4s), you
// currently must use the Elastic Transcoder API to list the jobs (as opposed
// to the AWS Console).
func (c *ElasticTranscoder) CreateJob(input *CreateJobInput) (*CreateJobResponse, error) {
req, out := c.CreateJobRequest(input)
err := req.Send()
return out, err
}
const opCreatePipeline = "CreatePipeline"
// CreatePipelineRequest generates a request for the CreatePipeline operation.
func (c *ElasticTranscoder) CreatePipelineRequest(input *CreatePipelineInput) (req *aws.Request, output *CreatePipelineOutput) {
op := &aws.Operation{
Name: opCreatePipeline,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/pipelines",
}
if input == nil {
input = &CreatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &CreatePipelineOutput{}
req.Data = output
return
}
// The CreatePipeline operation creates a pipeline with settings that you specify.
func (c *ElasticTranscoder) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error) {
req, out := c.CreatePipelineRequest(input)
err := req.Send()
return out, err
}
const opCreatePreset = "CreatePreset"
// CreatePresetRequest generates a request for the CreatePreset operation.
func (c *ElasticTranscoder) CreatePresetRequest(input *CreatePresetInput) (req *aws.Request, output *CreatePresetOutput) {
op := &aws.Operation{
Name: opCreatePreset,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/presets",
}
if input == nil {
input = &CreatePresetInput{}
}
req = c.newRequest(op, input, output)
output = &CreatePresetOutput{}
req.Data = output
return
}
// The CreatePreset operation creates a preset with settings that you specify.
//
// Elastic Transcoder checks the CreatePreset settings to ensure that they
// meet Elastic Transcoder requirements and to determine whether they comply
// with H.264 standards. If your settings are not valid for Elastic Transcoder,
// Elastic Transcoder returns an HTTP 400 response (ValidationException) and
// does not create the preset. If the settings are valid for Elastic Transcoder
// but aren't strictly compliant with the H.264 standard, Elastic Transcoder
// creates the preset and returns a warning message in the response. This helps
// you determine whether your settings comply with the H.264 standard while
// giving you greater flexibility with respect to the video that Elastic Transcoder
// produces. Elastic Transcoder uses the H.264 video-compression format. For
// more information, see the International Telecommunication Union publication
// Recommendation ITU-T H.264: Advanced video coding for generic audiovisual
// services.
func (c *ElasticTranscoder) CreatePreset(input *CreatePresetInput) (*CreatePresetOutput, error) {
req, out := c.CreatePresetRequest(input)
err := req.Send()
return out, err
}
const opDeletePipeline = "DeletePipeline"
// DeletePipelineRequest generates a request for the DeletePipeline operation.
func (c *ElasticTranscoder) DeletePipelineRequest(input *DeletePipelineInput) (req *aws.Request, output *DeletePipelineOutput) {
op := &aws.Operation{
Name: opDeletePipeline,
HTTPMethod: "DELETE",
HTTPPath: "/2012-09-25/pipelines/{Id}",
}
if input == nil {
input = &DeletePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &DeletePipelineOutput{}
req.Data = output
return
}
// The DeletePipeline operation removes a pipeline.
//
// You can only delete a pipeline that has never been used or that is not
// currently in use (doesn't contain any active jobs). If the pipeline is currently
// in use, DeletePipeline returns an error.
func (c *ElasticTranscoder) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error) {
req, out := c.DeletePipelineRequest(input)
err := req.Send()
return out, err
}
const opDeletePreset = "DeletePreset"
// DeletePresetRequest generates a request for the DeletePreset operation.
func (c *ElasticTranscoder) DeletePresetRequest(input *DeletePresetInput) (req *aws.Request, output *DeletePresetOutput) {
op := &aws.Operation{
Name: opDeletePreset,
HTTPMethod: "DELETE",
HTTPPath: "/2012-09-25/presets/{Id}",
}
if input == nil {
input = &DeletePresetInput{}
}
req = c.newRequest(op, input, output)
output = &DeletePresetOutput{}
req.Data = output
return
}
// The DeletePreset operation removes a preset that you've added in an AWS region.
//
// You can't delete the default presets that are included with Elastic Transcoder.
func (c *ElasticTranscoder) DeletePreset(input *DeletePresetInput) (*DeletePresetOutput, error) {
req, out := c.DeletePresetRequest(input)
err := req.Send()
return out, err
}
const opListJobsByPipeline = "ListJobsByPipeline"
// ListJobsByPipelineRequest generates a request for the ListJobsByPipeline operation.
func (c *ElasticTranscoder) ListJobsByPipelineRequest(input *ListJobsByPipelineInput) (req *aws.Request, output *ListJobsByPipelineOutput) {
op := &aws.Operation{
Name: opListJobsByPipeline,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/jobsByPipeline/{PipelineId}",
Paginator: &aws.Paginator{
InputTokens: []string{"PageToken"},
OutputTokens: []string{"NextPageToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &ListJobsByPipelineInput{}
}
req = c.newRequest(op, input, output)
output = &ListJobsByPipelineOutput{}
req.Data = output
return
}
// The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
//
// Elastic Transcoder returns all of the jobs currently in the specified pipeline.
// The response body contains one element for each job that satisfies the search
// criteria.
func (c *ElasticTranscoder) ListJobsByPipeline(input *ListJobsByPipelineInput) (*ListJobsByPipelineOutput, error) {
req, out := c.ListJobsByPipelineRequest(input)
err := req.Send()
return out, err
}
func (c *ElasticTranscoder) ListJobsByPipelinePages(input *ListJobsByPipelineInput, fn func(p *ListJobsByPipelineOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListJobsByPipelineRequest(input)
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListJobsByPipelineOutput), lastPage)
})
}
const opListJobsByStatus = "ListJobsByStatus"
// ListJobsByStatusRequest generates a request for the ListJobsByStatus operation.
func (c *ElasticTranscoder) ListJobsByStatusRequest(input *ListJobsByStatusInput) (req *aws.Request, output *ListJobsByStatusOutput) {
op := &aws.Operation{
Name: opListJobsByStatus,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/jobsByStatus/{Status}",
Paginator: &aws.Paginator{
InputTokens: []string{"PageToken"},
OutputTokens: []string{"NextPageToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &ListJobsByStatusInput{}
}
req = c.newRequest(op, input, output)
output = &ListJobsByStatusOutput{}
req.Data = output
return
}
// The ListJobsByStatus operation gets a list of jobs that have a specified
// status. The response body contains one element for each job that satisfies
// the search criteria.
func (c *ElasticTranscoder) ListJobsByStatus(input *ListJobsByStatusInput) (*ListJobsByStatusOutput, error) {
req, out := c.ListJobsByStatusRequest(input)
err := req.Send()
return out, err
}
func (c *ElasticTranscoder) ListJobsByStatusPages(input *ListJobsByStatusInput, fn func(p *ListJobsByStatusOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListJobsByStatusRequest(input)
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListJobsByStatusOutput), lastPage)
})
}
const opListPipelines = "ListPipelines"
// ListPipelinesRequest generates a request for the ListPipelines operation.
func (c *ElasticTranscoder) ListPipelinesRequest(input *ListPipelinesInput) (req *aws.Request, output *ListPipelinesOutput) {
op := &aws.Operation{
Name: opListPipelines,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/pipelines",
Paginator: &aws.Paginator{
InputTokens: []string{"PageToken"},
OutputTokens: []string{"NextPageToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &ListPipelinesInput{}
}
req = c.newRequest(op, input, output)
output = &ListPipelinesOutput{}
req.Data = output
return
}
// The ListPipelines operation gets a list of the pipelines associated with
// the current AWS account.
func (c *ElasticTranscoder) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error) {
req, out := c.ListPipelinesRequest(input)
err := req.Send()
return out, err
}
func (c *ElasticTranscoder) ListPipelinesPages(input *ListPipelinesInput, fn func(p *ListPipelinesOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListPipelinesRequest(input)
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListPipelinesOutput), lastPage)
})
}
const opListPresets = "ListPresets"
// ListPresetsRequest generates a request for the ListPresets operation.
func (c *ElasticTranscoder) ListPresetsRequest(input *ListPresetsInput) (req *aws.Request, output *ListPresetsOutput) {
op := &aws.Operation{
Name: opListPresets,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/presets",
Paginator: &aws.Paginator{
InputTokens: []string{"PageToken"},
OutputTokens: []string{"NextPageToken"},
LimitToken: "",
TruncationToken: "",
},
}
if input == nil {
input = &ListPresetsInput{}
}
req = c.newRequest(op, input, output)
output = &ListPresetsOutput{}
req.Data = output
return
}
// The ListPresets operation gets a list of the default presets included with
// Elastic Transcoder and the presets that you've added in an AWS region.
func (c *ElasticTranscoder) ListPresets(input *ListPresetsInput) (*ListPresetsOutput, error) {
req, out := c.ListPresetsRequest(input)
err := req.Send()
return out, err
}
func (c *ElasticTranscoder) ListPresetsPages(input *ListPresetsInput, fn func(p *ListPresetsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListPresetsRequest(input)
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListPresetsOutput), lastPage)
})
}
const opReadJob = "ReadJob"
// ReadJobRequest generates a request for the ReadJob operation.
func (c *ElasticTranscoder) ReadJobRequest(input *ReadJobInput) (req *aws.Request, output *ReadJobOutput) {
op := &aws.Operation{
Name: opReadJob,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/jobs/{Id}",
}
if input == nil {
input = &ReadJobInput{}
}
req = c.newRequest(op, input, output)
output = &ReadJobOutput{}
req.Data = output
return
}
// The ReadJob operation returns detailed information about a job.
func (c *ElasticTranscoder) ReadJob(input *ReadJobInput) (*ReadJobOutput, error) {
req, out := c.ReadJobRequest(input)
err := req.Send()
return out, err
}
const opReadPipeline = "ReadPipeline"
// ReadPipelineRequest generates a request for the ReadPipeline operation.
func (c *ElasticTranscoder) ReadPipelineRequest(input *ReadPipelineInput) (req *aws.Request, output *ReadPipelineOutput) {
op := &aws.Operation{
Name: opReadPipeline,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/pipelines/{Id}",
}
if input == nil {
input = &ReadPipelineInput{}
}
req = c.newRequest(op, input, output)
output = &ReadPipelineOutput{}
req.Data = output
return
}
// The ReadPipeline operation gets detailed information about a pipeline.
func (c *ElasticTranscoder) ReadPipeline(input *ReadPipelineInput) (*ReadPipelineOutput, error) {
req, out := c.ReadPipelineRequest(input)
err := req.Send()
return out, err
}
const opReadPreset = "ReadPreset"
// ReadPresetRequest generates a request for the ReadPreset operation.
func (c *ElasticTranscoder) ReadPresetRequest(input *ReadPresetInput) (req *aws.Request, output *ReadPresetOutput) {
op := &aws.Operation{
Name: opReadPreset,
HTTPMethod: "GET",
HTTPPath: "/2012-09-25/presets/{Id}",
}
if input == nil {
input = &ReadPresetInput{}
}
req = c.newRequest(op, input, output)
output = &ReadPresetOutput{}
req.Data = output
return
}
// The ReadPreset operation gets detailed information about a preset.
func (c *ElasticTranscoder) ReadPreset(input *ReadPresetInput) (*ReadPresetOutput, error) {
req, out := c.ReadPresetRequest(input)
err := req.Send()
return out, err
}
const opTestRole = "TestRole"
// TestRoleRequest generates a request for the TestRole operation.
func (c *ElasticTranscoder) TestRoleRequest(input *TestRoleInput) (req *aws.Request, output *TestRoleOutput) {
op := &aws.Operation{
Name: opTestRole,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/roleTests",
}
if input == nil {
input = &TestRoleInput{}
}
req = c.newRequest(op, input, output)
output = &TestRoleOutput{}
req.Data = output
return
}
// The TestRole operation tests the IAM role used to create the pipeline.
//
// The TestRole action lets you determine whether the IAM role you are using
// has sufficient permissions to let Elastic Transcoder perform tasks associated
// with the transcoding process. The action attempts to assume the specified
// IAM role, checks read access to the input and output buckets, and tries to
// send a test notification to Amazon SNS topics that you specify.
func (c *ElasticTranscoder) TestRole(input *TestRoleInput) (*TestRoleOutput, error) {
req, out := c.TestRoleRequest(input)
err := req.Send()
return out, err
}
const opUpdatePipeline = "UpdatePipeline"
// UpdatePipelineRequest generates a request for the UpdatePipeline operation.
func (c *ElasticTranscoder) UpdatePipelineRequest(input *UpdatePipelineInput) (req *aws.Request, output *UpdatePipelineOutput) {
op := &aws.Operation{
Name: opUpdatePipeline,
HTTPMethod: "PUT",
HTTPPath: "/2012-09-25/pipelines/{Id}",
}
if input == nil {
input = &UpdatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &UpdatePipelineOutput{}
req.Data = output
return
}
// Use the UpdatePipeline operation to update settings for a pipeline. When
// you change pipeline settings, your changes take effect immediately. Jobs
// that you have already submitted and that Elastic Transcoder has not started
// to process are affected in addition to jobs that you submit after you change
// settings.
func (c *ElasticTranscoder) UpdatePipeline(input *UpdatePipelineInput) (*UpdatePipelineOutput, error) {
req, out := c.UpdatePipelineRequest(input)
err := req.Send()
return out, err
}
const opUpdatePipelineNotifications = "UpdatePipelineNotifications"
// UpdatePipelineNotificationsRequest generates a request for the UpdatePipelineNotifications operation.
func (c *ElasticTranscoder) UpdatePipelineNotificationsRequest(input *UpdatePipelineNotificationsInput) (req *aws.Request, output *UpdatePipelineNotificationsOutput) {
op := &aws.Operation{
Name: opUpdatePipelineNotifications,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/pipelines/{Id}/notifications",
}
if input == nil {
input = &UpdatePipelineNotificationsInput{}
}
req = c.newRequest(op, input, output)
output = &UpdatePipelineNotificationsOutput{}
req.Data = output
return
}
// With the UpdatePipelineNotifications operation, you can update Amazon Simple
// Notification Service (Amazon SNS) notifications for a pipeline.
//
// When you update notifications for a pipeline, Elastic Transcoder returns
// the values that you specified in the request.
func (c *ElasticTranscoder) UpdatePipelineNotifications(input *UpdatePipelineNotificationsInput) (*UpdatePipelineNotificationsOutput, error) {
req, out := c.UpdatePipelineNotificationsRequest(input)
err := req.Send()
return out, err
}
const opUpdatePipelineStatus = "UpdatePipelineStatus"
// UpdatePipelineStatusRequest generates a request for the UpdatePipelineStatus operation.
func (c *ElasticTranscoder) UpdatePipelineStatusRequest(input *UpdatePipelineStatusInput) (req *aws.Request, output *UpdatePipelineStatusOutput) {
op := &aws.Operation{
Name: opUpdatePipelineStatus,
HTTPMethod: "POST",
HTTPPath: "/2012-09-25/pipelines/{Id}/status",
}
if input == nil {
input = &UpdatePipelineStatusInput{}
}
req = c.newRequest(op, input, output)
output = &UpdatePipelineStatusOutput{}
req.Data = output
return
}
// The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that
// the pipeline stops or restarts the processing of jobs.
//
// Changing the pipeline status is useful if you want to cancel one or more
// jobs. You can't cancel jobs after Elastic Transcoder has started processing
// them; if you pause the pipeline to which you submitted the jobs, you have
// more time to get the job IDs for the jobs that you want to cancel, and to
// send a CancelJob request.
func (c *ElasticTranscoder) UpdatePipelineStatus(input *UpdatePipelineStatusInput) (*UpdatePipelineStatusOutput, error) {
req, out := c.UpdatePipelineStatusRequest(input)
err := req.Send()
return out, err
}
// The file to be used as album art. There can be multiple artworks associated
// with an audio file, to a maximum of 20.
//
// To remove artwork or leave the artwork empty, you can either set Artwork
// to null, or set the Merge Policy to "Replace" and use an empty Artwork array.
//
// To pass through existing artwork unchanged, set the Merge Policy to "Prepend",
// "Append", or "Fallback", and use an empty Artwork array.
type Artwork struct {
// The format of album art, if any. Valid formats are .jpg and .png.
AlbumArtFormat *string `type:"string"`
// The encryption settings, if any, that you want Elastic Transcoder to apply
// to your artwork.
Encryption *Encryption `type:"structure"`
// The name of the file to be used as album art. To determine which Amazon S3
// bucket contains the specified file, Elastic Transcoder checks the pipeline
// specified by PipelineId; the InputBucket object in that pipeline identifies
// the bucket.
//
// If the file name includes a prefix, for example, cooking/pie.jpg, include
// the prefix in the key. If the file isn't in the specified bucket, Elastic
// Transcoder returns an error.
InputKey *string `type:"string"`
// The maximum height of the output album art in pixels. If you specify auto,
// Elastic Transcoder uses 600 as the default value. If you specify a numeric
// value, enter an even integer between 32 and 3072, inclusive.
MaxHeight *string `type:"string"`
// The maximum width of the output album art in pixels. If you specify auto,
// Elastic Transcoder uses 600 as the default value. If you specify a numeric
// value, enter an even integer between 32 and 4096, inclusive.
MaxWidth *string `type:"string"`
// When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars
// to the top and bottom and/or left and right sides of the output album art
// to make the total size of the output art match the values that you specified
// for MaxWidth and MaxHeight.
PaddingPolicy *string `type:"string"`
// Specify one of the following values to control scaling of the output album
// art:
//
// Fit: Elastic Transcoder scales the output art so it matches the value
// that you specified in either MaxWidth or MaxHeight without exceeding the
// other value. Fill: Elastic Transcoder scales the output art so it matches
// the value that you specified in either MaxWidth or MaxHeight and matches
// or exceeds the other value. Elastic Transcoder centers the output art and
// then crops it in the dimension (if any) that exceeds the maximum value.
// Stretch: Elastic Transcoder stretches the output art to match the values
// that you specified for MaxWidth and MaxHeight. If the relative proportions
// of the input art and the output art are different, the output art will be
// distorted. Keep: Elastic Transcoder does not scale the output art. If either
// dimension of the input art exceeds the values that you specified for MaxWidth
// and MaxHeight, Elastic Transcoder crops the output art. ShrinkToFit: Elastic
// Transcoder scales the output art down so that its dimensions match the values
// that you specified for at least one of MaxWidth and MaxHeight without exceeding
// either value. If you specify this option, Elastic Transcoder does not scale
// the art up. ShrinkToFill Elastic Transcoder scales the output art down so
// that its dimensions match the values that you specified for at least one
// of MaxWidth and MaxHeight without dropping below either value. If you specify
// this option, Elastic Transcoder does not scale the art up.
SizingPolicy *string `type:"string"`
metadataArtwork `json:"-" xml:"-"`
}
type metadataArtwork struct {
SDKShapeTraits bool `type:"structure"`
}
// Options associated with your audio codec.
type AudioCodecOptions struct {
// You can only choose an audio bit depth when you specify flac or pcm for the
// value of Audio:Codec.
//
// The bit depth of a sample is how many bits of information are included in
// the audio samples. The higher the bit depth, the better the audio, but the
// larger the file.
//
// Valid values are 16 and 24.
//
// The most common bit depth is 24.
BitDepth *string `type:"string"`
// You can only choose an audio bit order when you specify pcm for the value
// of Audio:Codec.
//
// The order the bits of a PCM sample are stored in.
//
// The supported value is LittleEndian.
BitOrder *string `type:"string"`
// You can only choose an audio profile when you specify AAC for the value of
// Audio:Codec.
//
// Specify the AAC profile for the output file. Elastic Transcoder supports
// the following profiles:
//
// auto: If you specify auto, Elastic Transcoder will select the profile
// based on the bit rate selected for the output file. AAC-LC: The most common
// AAC profile. Use for bit rates larger than 64 kbps. HE-AAC: Not supported
// on some older players and devices. Use for bit rates between 40 and 80 kbps.
// HE-AACv2: Not supported on some players and devices. Use for bit rates less
// than 48 kbps. All outputs in a Smooth playlist must have the same value
// for Profile.
//
// If you created any presets before AAC profiles were added, Elastic Transcoder
// automatically updated your presets to use AAC-LC. You can change the value
// as required.
Profile *string `type:"string"`
// You can only choose whether an audio sample is signed when you specify pcm
// for the value of Audio:Codec.
//
// Whether audio samples are represented with negative and positive numbers
// (signed) or only positive numbers (unsigned).
//
// The supported value is Signed.
Signed *string `type:"string"`
metadataAudioCodecOptions `json:"-" xml:"-"`
}
type metadataAudioCodecOptions struct {
SDKShapeTraits bool `type:"structure"`
}
// Parameters required for transcoding audio.
type AudioParameters struct {
// The method of organizing audio channels and tracks. Use Audio:Channels to
// specify the number of channels in your output, and Audio:AudioPackingMode
// to specify the number of tracks and their relation to the channels. If you
// do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.
//
// The following values are valid:
//
// SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks
//
// When you specify SingleTrack, Elastic Transcoder creates a single track
// for your output. The track can have up to eight channels. Use SingleTrack
// for all non-mxf containers.
//
// The outputs of SingleTrack for a specific channel value and inputs are as
// follows:
//
// 0 channels with any input: Audio omitted from the output 1, 2, or auto
// channels with no audio input: Audio omitted from the output 1 channel
// with any input with audio: One track with one channel, downmixed if necessary
// 2 channels with one track with one channel: One track with two identical
// channels 2 or auto channels with two tracks with one channel each: One
// track with two channels 2 or auto channels with one track with two channels:
// One track with two channels 2 channels with one track with multiple channels:
// One track with two channels auto channels with one track with one channel:
// One track with one channel auto channels with one track with multiple channels:
// One track with multiple channels When you specify OneChannelPerTrack, Elastic
// Transcoder creates a new track for every channel in your output. Your output
// can have up to eight single-channel tracks.
//
// The outputs of OneChannelPerTrack for a specific channel value and inputs
// are as follows:
//
// 0 channels with any input: Audio omitted from the output 1, 2, or auto
// channels with no audio input: Audio omitted from the output 1 channel
// with any input with audio: One track with one channel, downmixed if necessary
// 2 channels with one track with one channel: Two tracks with one identical
// channel each 2 or auto channels with two tracks with one channel each:
// Two tracks with one channel each 2 or auto channels with one track with
// two channels: Two tracks with one channel each 2 channels with one track
// with multiple channels: Two tracks with one channel each auto channels
// with one track with one channel: One track with one channel auto channels
// with one track with multiple channels: Up to eight tracks with one channel
// each When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder
// creates eight single-channel tracks for your output. All tracks that do not
// contain audio data from an input channel are MOS, or Mit Out Sound, tracks.
//
// The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel
// value and inputs are as follows:
//
// 0 channels with any input: Audio omitted from the output 1, 2, or auto
// channels with no audio input: Audio omitted from the output 1 channel
// with any input with audio: One track with one channel, downmixed if necessary,
// plus six MOS tracks 2 channels with one track with one channel: Two tracks
// with one identical channel each, plus six MOS tracks 2 or auto channels
// with two tracks with one channel each: Two tracks with one channel each,
// plus six MOS tracks 2 or auto channels with one track with two channels:
// Two tracks with one channel each, plus six MOS tracks 2 channels with one
// track with multiple channels: Two tracks with one channel each, plus six
// MOS tracks auto channels with one track with one channel: One track with
// one channel, plus seven MOS tracks auto channels with one track with multiple
// channels: Up to eight tracks with one channel each, plus MOS tracks until
// there are eight tracks in all
AudioPackingMode *string `type:"string"`
// The bit rate of the audio stream in the output file, in kilobits/second.
// Enter an integer between 64 and 320, inclusive.
BitRate *string `type:"string"`
// The number of audio channels in the output file. The following values are
// valid:
//
// auto, 0, 1, 2
//
// One channel carries the information played by a single speaker. For example,
// a stereo track with two channels sends one channel to the left speaker, and
// the other channel to the right speaker. The output channels are organized
// into tracks. If you want Elastic Transcoder to automatically detect the number
// of audio channels in the input file and use that value for the output file,
// select auto.
//
// The output of a specific channel value and inputs are as follows:
//
// auto channel specified, with any input: Pass through up to eight input
// channels. 0 channels specified, with any input: Audio omitted from the output.
// 1 channel specified, with at least one input channel: Mono sound. 2 channels
// specified, with any input: Two identical mono channels or stereo. For more
// information about tracks, see Audio:AudioPackingMode. For more information
// about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode.
Channels *string `type:"string"`
// The audio codec for the output file. Valid values include aac, flac, mp2,
// mp3, pcm, and vorbis.
Codec *string `type:"string"`
// If you specified AAC for Audio:Codec, this is the AAC compression profile
// to use. Valid values include:
//
// auto, AAC-LC, HE-AAC, HE-AACv2
//
// If you specify auto, Elastic Transcoder chooses a profile based on the bit
// rate of the output file.
CodecOptions *AudioCodecOptions `type:"structure"`
// The sample rate of the audio stream in the output file, in Hertz. Valid values
// include:
//
// auto, 22050, 32000, 44100, 48000, 96000
//
// If you specify auto, Elastic Transcoder automatically detects the sample
// rate.
SampleRate *string `type:"string"`
metadataAudioParameters `json:"-" xml:"-"`
}
type metadataAudioParameters struct {
SDKShapeTraits bool `type:"structure"`
}
// The CancelJobRequest structure.
type CancelJobInput struct {
// The identifier of the job that you want to cancel.
//
// To get a list of the jobs (including their jobId) that have a status of
// Submitted, use the ListJobsByStatus API action.
ID *string `location:"uri" locationName:"Id" type:"string" required:"true"`
metadataCancelJobInput `json:"-" xml:"-"`
}
type metadataCancelJobInput struct {
SDKShapeTraits bool `type:"structure"`
}
// The response body contains a JSON object. If the job is successfully canceled,
// the value of Success is true.
type CancelJobOutput struct {
metadataCancelJobOutput `json:"-" xml:"-"`
}
type metadataCancelJobOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// The file format of the output captions. If you leave this value blank, Elastic
// Transcoder returns an error.
type CaptionFormat struct {
// The encryption settings, if any, that you want Elastic Transcoder to apply
// to your caption formats.
Encryption *Encryption `type:"structure"`
// The format you specify determines whether Elastic Transcoder generates an
// embedded or sidecar caption for this output.
//
// Valid Embedded Caption Formats:
//
// for FLAC: None
//
// For MP3: None
//
// For MP4: mov-text
//
// For MPEG-TS: None
//
// For ogg: None
//
// For webm: None
//
// Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first
// div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible
// captions, specify dfxp as your output format.
//
// For FMP4: dfxp
//
// Non-FMP4 outputs: All sidecar types
//
// fmp4 captions have an extension of .ismt
Format *string `type:"string"`
// The prefix for caption filenames, in the form description-{language}, where:
//
// description is a description of the video. {language} is a literal value
// that Elastic Transcoder replaces with the two- or three-letter code for the
// language of the caption in the output file names. If you don't include {language}
// in the file name pattern, Elastic Transcoder automatically appends "{language}"
// to the value that you specify for the description. In addition, Elastic Transcoder
// automatically appends the count to the end of the segment files.
//
// For example, suppose you're transcoding into srt format. When you enter
// "Sydney-{language}-sunrise", and the language of the captions is English
// (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
Pattern *string `type:"string"`
metadataCaptionFormat `json:"-" xml:"-"`
}
type metadataCaptionFormat struct {
SDKShapeTraits bool `type:"structure"`
}
// A source file for the input sidecar captions used during the transcoding
// process.
type CaptionSource struct {
// The encryption settings, if any, that you want Elastic Transcoder to apply
// to your caption sources.
Encryption *Encryption `type:"structure"`
// The name of the sidecar caption file that you want Elastic Transcoder to
// include in the output file.
Key *string `type:"string"`
// The label of the caption shown in the player when choosing a language. We
// recommend that you put the caption language name here, in the language of
// the captions.
Label *string `type:"string"`
// A string that specifies the language of the caption. Specify this as one
// of:
//
// 2-character ISO 639-1 code
//
// 3-character ISO 639-2 code
//
// For more information on ISO language codes and language names, see the
// List of ISO 639-1 codes.
Language *string `type:"string"`
// For clip generation or captions that do not start at the same time as the
// associated video file, the TimeOffset tells Elastic Transcoder how much of
// the video to encode before including captions.
//
// Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
TimeOffset *string `type:"string"`
metadataCaptionSource `json:"-" xml:"-"`
}
type metadataCaptionSource struct {
SDKShapeTraits bool `type:"structure"`
}
// The captions to be created, if any.
type Captions struct {
// The array of file formats for the output captions. If you leave this value
// blank, Elastic Transcoder returns an error.
CaptionFormats []*CaptionFormat `type:"list"`
// Source files for the input sidecar captions used during the transcoding process.
// To omit all sidecar captions, leave CaptionSources blank.
CaptionSources []*CaptionSource `type:"list"`
// A policy that determines how Elastic Transcoder handles the existence of
// multiple captions.
//
// MergeOverride: Elastic Transcoder transcodes both embedded and sidecar
// captions into outputs. If captions for a language are embedded in the input
// file and also appear in a sidecar file, Elastic Transcoder uses the sidecar
// captions and ignores the embedded captions for that language.
//
// MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions
// into outputs. If captions for a language are embedded in the input file and
// also appear in a sidecar file, Elastic Transcoder uses the embedded captions
// and ignores the sidecar captions for that language. If CaptionSources is
// empty, Elastic Transcoder omits all sidecar captions from the output files.
//
// Override: Elastic Transcoder transcodes only the sidecar captions that you
// specify in CaptionSources.
//
// MergePolicy cannot be null.
MergePolicy *string `type:"string"`
metadataCaptions `json:"-" xml:"-"`
}
type metadataCaptions struct {
SDKShapeTraits bool `type:"structure"`
}
// Settings for one clip in a composition. All jobs in a playlist must have
// the same clip settings.
type Clip struct {
// Settings that determine when a clip begins and how long it lasts.
TimeSpan *TimeSpan `type:"structure"`
metadataClip `json:"-" xml:"-"`
}
type metadataClip struct {
SDKShapeTraits bool `type:"structure"`