Class: Aws::ElasticTranscoder::Types::CreateJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticTranscoder::Types::CreateJobRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-elastictranscoder/types.rb
Overview
When making an API call, you may pass CreateJobRequest data as a hash:
{
pipeline_id: "Id", # required
input: {
key: "LongKey",
frame_rate: "FrameRate",
resolution: "Resolution",
aspect_ratio: "AspectRatio",
interlaced: "Interlaced",
container: "JobContainer",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
time_span: {
start_time: "Time",
duration: "Time",
},
input_captions: {
merge_policy: "CaptionMergePolicy",
caption_sources: [
{
key: "LongKey",
language: "Key",
time_offset: "TimeOffset",
label: "Name",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
detected_properties: {
width: 1,
height: 1,
frame_rate: "FloatString",
file_size: 1,
duration_millis: 1,
},
},
inputs: [
{
key: "LongKey",
frame_rate: "FrameRate",
resolution: "Resolution",
aspect_ratio: "AspectRatio",
interlaced: "Interlaced",
container: "JobContainer",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
time_span: {
start_time: "Time",
duration: "Time",
},
input_captions: {
merge_policy: "CaptionMergePolicy",
caption_sources: [
{
key: "LongKey",
language: "Key",
time_offset: "TimeOffset",
label: "Name",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
detected_properties: {
width: 1,
height: 1,
frame_rate: "FloatString",
file_size: 1,
duration_millis: 1,
},
},
],
output: {
key: "Key",
thumbnail_pattern: "ThumbnailPattern",
thumbnail_encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
rotate: "Rotate",
preset_id: "Id",
segment_duration: "FloatString",
watermarks: [
{
preset_watermark_id: "PresetWatermarkId",
input_key: "WatermarkKey",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
album_art: {
merge_policy: "MergePolicy",
artwork: [
{
input_key: "WatermarkKey",
max_width: "DigitsOrAuto",
max_height: "DigitsOrAuto",
sizing_policy: "SizingPolicy",
padding_policy: "PaddingPolicy",
album_art_format: "JpgOrPng",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
composition: [
{
time_span: {
start_time: "Time",
duration: "Time",
},
},
],
captions: {
merge_policy: "CaptionMergePolicy",
caption_sources: [
{
key: "LongKey",
language: "Key",
time_offset: "TimeOffset",
label: "Name",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
caption_formats: [
{
format: "CaptionFormatFormat",
pattern: "CaptionFormatPattern",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
outputs: [
{
key: "Key",
thumbnail_pattern: "ThumbnailPattern",
thumbnail_encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
rotate: "Rotate",
preset_id: "Id",
segment_duration: "FloatString",
watermarks: [
{
preset_watermark_id: "PresetWatermarkId",
input_key: "WatermarkKey",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
album_art: {
merge_policy: "MergePolicy",
artwork: [
{
input_key: "WatermarkKey",
max_width: "DigitsOrAuto",
max_height: "DigitsOrAuto",
sizing_policy: "SizingPolicy",
padding_policy: "PaddingPolicy",
album_art_format: "JpgOrPng",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
composition: [
{
time_span: {
start_time: "Time",
duration: "Time",
},
},
],
captions: {
merge_policy: "CaptionMergePolicy",
caption_sources: [
{
key: "LongKey",
language: "Key",
time_offset: "TimeOffset",
label: "Name",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
caption_formats: [
{
format: "CaptionFormatFormat",
pattern: "CaptionFormatPattern",
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
},
encryption: {
mode: "EncryptionMode",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
},
},
],
output_key_prefix: "Key",
playlists: [
{
name: "Filename",
format: "PlaylistFormat",
output_keys: ["Key"],
hls_content_protection: {
method: "HlsContentProtectionMethod",
key: "Base64EncodedString",
key_md_5: "Base64EncodedString",
initialization_vector: "ZeroTo255String",
license_acquisition_url: "ZeroTo512String",
key_storage_policy: "KeyStoragePolicy",
},
play_ready_drm: {
format: "PlayReadyDrmFormatString",
key: "NonEmptyBase64EncodedString",
key_md_5: "NonEmptyBase64EncodedString",
key_id: "KeyIdGuid",
initialization_vector: "ZeroTo255String",
license_acquisition_url: "OneTo512String",
},
},
],
user_metadata: {
"String" => "String",
},
}
The ‘CreateJobRequest` structure.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#input ⇒ Types::JobInput
A section of the request body that provides information about the file that is being transcoded.
-
#inputs ⇒ Array<Types::JobInput>
A section of the request body that provides information about the files that are being transcoded.
-
#output ⇒ Types::CreateJobOutput
A section of the request body that provides information about the transcoded (target) file.
-
#output_key_prefix ⇒ String
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
-
#outputs ⇒ Array<Types::CreateJobOutput>
A section of the request body that provides information about the transcoded (target) files.
-
#pipeline_id ⇒ String
The ‘Id` of the pipeline that you want Elastic Transcoder to use for transcoding.
-
#playlists ⇒ Array<Types::CreateJobPlaylist>
If you specify a preset in ‘PresetId` for which the value of `Container` is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.
-
#user_metadata ⇒ Hash<String,String>
User-defined metadata that you want to associate with an Elastic Transcoder job.
Instance Attribute Details
#input ⇒ Types::JobInput
A section of the request body that provides information about the file that is being transcoded.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#inputs ⇒ Array<Types::JobInput>
A section of the request body that provides information about the files that are being transcoded.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#output ⇒ Types::CreateJobOutput
A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the ‘Outputs` syntax instead of the `Output` syntax.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#output_key_prefix ⇒ String
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#outputs ⇒ Array<Types::CreateJobOutput>
A section of the request body that provides information about the transcoded (target) files. We recommend that you use the ‘Outputs` syntax instead of the `Output` syntax.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#pipeline_id ⇒ String
The ‘Id` of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#playlists ⇒ Array<Types::CreateJobPlaylist>
If you specify a preset in ‘PresetId` for which the value of `Container` is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#user_metadata ⇒ Hash<String,String>
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in ‘key/value` pairs, and you can add up to 10 `key/value` pairs per job. Elastic Transcoder does not guarantee that `key/value` pairs are returned in the same order in which you specify them.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-elastictranscoder/types.rb', line 1447 class CreateJobRequest < Struct.new( :pipeline_id, :input, :inputs, :output, :outputs, :output_key_prefix, :playlists, :user_metadata) SENSITIVE = [] include Aws::Structure end |