{
"api_version": "2012-09-25",
"type": "rest-json",
"signature_version": "v4",
"service_full_name": "Amazon Elastic Transcoder",
"endpoint_prefix": "elastictranscoder",
"xmlnamespace": "http://elastictranscoder.amazonaws.com/doc/2012-09-25/",
"documentation": "\n
The AWS Elastic Transcoder Service.
\n ", "operations": { "CancelJob": { "name": "CancelJob", "http": { "method": "DELETE", "uri": "/2012-09-25/jobs/{Id}", "response_code": 202 }, "input": { "shape_name": "CancelJobRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\nThe identifier of the job that you want to cancel.
\nTo get a list of the jobs (including their jobId
) that have a status of\n Submitted
, use the ListJobsByStatus API action.
The CancelJobRequest
structure.
The response body contains a JSON object. If the job is successfully canceled, the value\n of Success
is true
.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\nThe resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe CancelJob operation cancels an unfinished job.
\nSubmitted
. To prevent a\n pipeline from starting to process a job while you're getting the job identifier, use\n UpdatePipelineStatus to temporarily pause the pipeline.The Id
of the pipeline that you want Elastic Transcoder to use for\n transcoding. The pipeline determines several settings, including the Amazon S3 bucket\n from which Elastic Transcoder gets the files to transcode and the bucket into which\n Elastic Transcoder puts the transcoded files.
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket
object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg
, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto
. If you want to specify the frame rate for\n the input file, enter one of the following values:
\n 10
, 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n the frame rate.
This value must be auto
, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto
. If you want to specify the aspect\n ratio for the output file, enter one of the following values:
\n 1:1
, 4:3
, 3:2
, 16:9
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection\n of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto
. If you want to specify whether\n the input file is interlaced, enter one of the following values:
true
, false
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto
. If you want to specify the\n container type for the input file, enter one of the following values:
\n 3gp
, aac
, asf
, avi
, \n divx
, flv
, m4a
, mkv
, \n mov
, mp3
, mp4
, mpeg
, \n mpeg-ps
, mpeg-ts
, mxf
, ogg
, \n vob
, wav
, webm
\n
A section of the request body that provides information about the file that is being\n transcoded.
\n ", "required": true }, "Output": { "shape_name": "CreateJobOutput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values: auto
, 0
,\n 90
, 180
, 270
. The value auto
\n generally works only if the file that you're transcoding contains rotation metadata.\n
The Id
of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding.
If you specify a preset in PresetId
for which the value of\n Container
is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset for the current output.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output file. \n For the current release, you can only specify settings for a single clip per output \n file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n \tCEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nThe CreateJobOutput
structure.
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values: auto
, 0
,\n 90
, 180
, 270
. The value auto
\n generally works only if the file that you're transcoding contains rotation metadata.\n
The Id
of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding.
If you specify a preset in PresetId
for which the value of\n Container
is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset for the current output.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output file. \n For the current release, you can only specify settings for a single clip per output \n file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n \tCEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nThe CreateJobOutput
structure.
A section of the request body that provides information about the transcoded (target)\n files. We recommend that you use the Outputs
syntax instead of the\n Output
syntax.
The value, if any, that you want Elastic Transcoder to prepend to the names of all files\n that this job creates, including output files, thumbnails, and playlists.
\n " }, "Playlists": { "shape_name": "CreateJobPlaylists", "type": "list", "members": { "shape_name": "CreateJobPlaylist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name
objects must be\n unique. Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name
, it will appear twice in the file name.
This value must currently be HLSv3.
\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\nFor each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key
object. If you include more than one output in a playlist,\n the value of SegmentDuration
for all of the outputs must be the same.
Information about the master playlist.
\n " }, "max_length": 30, "documentation": "\nIf you specify a preset in PresetId
for which the value of\n Container
is ts (MPEG-TS), Playlists contains information about the\n master playlists that you want Elastic Transcoder to create.
We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.
\n " } }, "documentation": "\nThe CreateJobRequest
structure.
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the job.
\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n The Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket
object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg
, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto
. If you want to specify the frame rate for\n the input file, enter one of the following values:
\n 10
, 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n the frame rate.
This value must be auto
, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto
. If you want to specify the aspect\n ratio for the output file, enter one of the following values:
\n 1:1
, 4:3
, 3:2
, 16:9
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection\n of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto
. If you want to specify whether\n the input file is interlaced, enter one of the following values:
true
, false
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto
. If you want to specify the\n container type for the input file, enter one of the following values:
\n 3gp
, aac
, asf
, avi
, \n divx
, flv
, m4a
, mkv
, \n mov
, mp3
, mp4
, mpeg
, \n mpeg-ps
, mpeg-ts
, mxf
, ogg
, \n vob
, wav
, webm
\n
A section of the request or response body that provides information about the file that\n is being transcoded.
\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nIf you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.
\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nOutput
object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs
\n object.
Information about the output files. We recommend that you use the Outputs
\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs
and Output
syntaxes in\n the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.
\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix
.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name
objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name
, it will appear twice in the file name.
This value must currently be HLSv3
.
For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration
for all of the outputs must be the same.
The status of the job with which the playlist is associated.
\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nInformation that further explains the status.
\n " } }, "documentation": "\n Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts
(MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.
PresetId
for which the value of Container
is ts (MPEG-TS),\n Playlists
contains information about the master playlists that you want\n Elastic Transcoder to create.
We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.
\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n The status of the job: Submitted
, Progressing
, Complete
,\n Canceled
, or Error
.
A section of the response body that provides information about the job that is created.\n
\n " } }, "documentation": "\nThe CreateJobResponse structure.
\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\nOne or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nToo many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nWhen you create a job, Elastic Transcoder returns JSON data that includes the values\n that you specified plus information about the job that is created.
\nIf you have specified more than one output for your jobs (for example, one output for the\n Kindle Fire and another output for the Apple iPhone 4s), you currently must use the\n Elastic Transcoder API to list the jobs (as opposed to the AWS Console).
\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters.
\n ", "required": true }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you saved the media files that you want to transcode.
\n ", "required": true }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use\n ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
\nSpecify this value when all of the following are true:
OutputBucket
, it grants full control over the files only to\n the AWS account that owns the role that is specified by\n Role
.If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket
\n and specify values for ContentConfig
and ThumbnailConfig
\n instead.
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the\n pipeline.
\n ", "required": true }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
The optional ContentConfig
object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.
If you specify values for ContentConfig
, you must also specify values for\n ThumbnailConfig
.
If you specify values for ContentConfig
and ThumbnailConfig
,\n omit the OutputBucket
object.
Grantee
object: Grantee
object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. For more information about canonical user\n IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage\n Service Developer Guide. For more information about using CloudFront origin\n access identities to require that users use CloudFront URLs instead of\n Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to\n Your Amazon S3 Content. Grantee
object is the registered\n email address of an AWS account.Grantee
object is one of the\n following predefined Amazon S3 groups: AllUsers
,\n AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include: READ
: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the video files and playlists that it stores in your Amazon S3 bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
The ThumbnailConfig
object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.
If you specify values for ContentConfig
, you must also specify values for\n ThumbnailConfig
even if you don't want to create thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
,\n omit the OutputBucket
object.
Permissions
object specifies which\n users and/or predefined Amazon S3 groups you want to have access to thumbnail files,\n and the type of access you want them to have. You can grant permissions to a maximum\n of 30 users and/or predefined Amazon S3 groups.Grantee
object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. Grantee
object is the registered\n email address of an AWS account. Grantee
object is one of the\n following predefined Amazon S3 groups: AllUsers
,\n AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include: READ
: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions for the\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.The CreatePipelineRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.A section of the response body that provides information about the pipeline that is\n created.
\n " } }, "documentation": "\nWhen you create a pipeline, Elastic Transcoder returns the values that you specified in the\n request.
\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\nOne or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nToo many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe CreatePipeline operation creates a pipeline with settings that you specify.
\nThe name of the preset. We recommend that the name be unique within the AWS account, but\n uniqueness is not enforced.
\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nA description of the preset.
\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\nThe container type for the output file. Valid values include mp3
, \n mp4
, ogg
, ts
, and webm
.
The video codec for the output file. Valid values include H.264
and\n vp8
. You can only specify vp8
when the container type is\n webm
.
\n Profile\n
\nThe H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:
\nbaseline
: The profile most commonly used for videoconferencing and for\n mobile applications.main
: The profile used for standard-definition digital TV\n broadcasts.high
: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.\n Level (H.264 Only)\n
\nThe H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:
\n1
, 1b
, 1.1
, 1.2
, 1.3
,\n 2
, 2.1
, 2.2
, 3
,\n 3.1
, 3.2
, 4
, 4.1
\n MaxReferenceFrames (H.264 Only)\n
\nApplicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:
\n\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)
\n
where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level
object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)
\n MaxBitRate\n
\nThe maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize
. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.
\n BufferSize\n
\nThe maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate
and omit BufferSize
, Elastic Transcoder sets\n BufferSize
to 10 times the value of MaxBitRate
.
The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.
\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\nWhether to use a fixed value for FixedGOP
. Valid values are\n true
and false
:
true
: Elastic Transcoder uses the value of KeyframesMaxDist
for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).false
: The distance between key frames can vary.The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level
and Profile
. If you specify\n auto
, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto
, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:
\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n
\nThe frames per second for the video stream in the output file. Valid values include:
\nauto
, 10
, 15
, 23.97
, 24
,\n 25
, 29.97
, 30
, 60
If you specify auto
, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:
\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)
\n
where:
\nThe maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):
\nIf you specify auto
for FrameRate
, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10
,\n 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
.
To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The width and height of the video in the output file, in pixels. Valid values are\n auto
and width x height:
auto
: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.width x height
: The width and height of the output video\n in pixels.Note the following about specifying the width and height:
\nTo better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The display aspect ratio of the video in the output file. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.
\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n The maximum width of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.
The maximum height of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.
The value that Elastic Transcoder adds to the metadata in the output file.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of the output video:
\n\n
Fit
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without\n exceeding the other value.Fill
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches\n or exceeds the other value. Elastic Transcoder centers the output video and then crops it in\n the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches the output video to match the values that\n you specified for MaxWidth
and MaxHeight
. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.Keep
: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n MaxWidth
and MaxHeight
, Elastic Transcoder crops the output\n video.ShrinkToFit
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth
\n and MaxHeight
.
Id
can be up to 40 characters long. "
},
"MaxWidth": {
"shape_name": "PixelsOrPercent",
"type": "string",
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
"documentation": "\n The maximum width of the watermark in one of the following formats:
MaxWidth
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxWidth
.The maximum height of the watermark in one of the following formats:
MaxHeight
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxHeight
.\n "
},
"SizingPolicy": {
"shape_name": "WatermarkSizingPolicy",
"type": "string",
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
"documentation": "\n A value that controls scaling of the watermark:
MaxWidth
or MaxHeight
without\n exceeding the other value.MaxWidth
and MaxHeight
. If the\n relative proportions of the watermark and the values of MaxWidth
\n and MaxHeight
are different, the watermark will be distorted.MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset
:
The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:
HorizontalAlign
and 5px for\n HorizontalOffset
, the left side of the watermark appears 5 pixels from\n the left border of the output video.\n HorizontalOffset
is only valid when the value of\n HorizontalAlign
is Left
or Right
. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.
Use the value of Target
to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.
The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset
:
VerticalOffset
\n The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:
MaxHeight
.Top
for VerticalAlign
and\n 5px
for VerticalOffset
, the top of the watermark appears 5\n pixels from the top border of the output video.\n VerticalOffset
is only valid when the value of VerticalAlign is Top or\n Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.
\n\nUse the value of Target
to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.
A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity
is float.
Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity
. The .jpg file format doesn't support transparency.
A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset
, VerticalOffset
, MaxWidth
,\n and MaxHeight
:
HorizontalOffset
and\n VerticalOffset
values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n MaxWidth
and MaxHeight
, if specified as a\n percentage, are calculated based on the borders of the video excluding black\n bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.MaxWidth
and\n MaxHeight
, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " }, "documentation": "\nSettings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " } }, "documentation": "\nA section of the request body that specifies the video parameters.
\n " }, "Audio": { "shape_name": "AudioParameters", "type": "structure", "members": { "Codec": { "shape_name": "AudioCodec", "type": "string", "pattern": "(^AAC$)|(^vorbis$)|(^mp3$)", "documentation": "\nThe audio codec for the output file. Valid values include aac
, \n mp3
, and vorbis
.
The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:
\nauto
, 22050
, 32000
, 44100
,\n 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.
\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\nThe number of audio channels in the output file. Valid values include:
\nauto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically detects the number of channels in\n the input file.
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
\nSpecify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
\nauto
: If you specify auto
, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.AAC-LC
: The most common AAC profile. Use for bitrates larger than\n 64 kbps.HE-AAC
: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.
If you specified AAC
for Audio:Codec
, this is the AAC
\n 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.
A section of the request body that specifies the audio parameters.
\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\nThe format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\nThe number of seconds between thumbnails. Specify an integer value.
\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\nTo better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format\n width
x height
where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution
object.
To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.
\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\nThe maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of thumbnails:
\n\n
Fit
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding\n the other value. Fill
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth
or MaxHeight
\n settings and matches or exceeds the other value. Elastic Transcoder centers the\n image in thumbnails and then crops in the dimension (if any) that exceeds the\n maximum value.Stretch
: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail MaxWidth
and\n MaxHeight
settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.Keep
: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings, Elastic\n Transcoder crops the thumbnails.ShrinkToFit
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail MaxWidth
and MaxHeight
without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.ShrinkToFill
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings.
A section of the request body that specifies the thumbnail parameters, if any.
\n " } }, "documentation": "\nThe CreatePresetRequest
structure.
Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the preset.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the preset.
\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nA description of the preset.
\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\nThe container type for the output file. Valid values include mp3
,\n mp4
, ogg
, ts
, and webm
.
The audio codec for the output file. Valid values include aac
, \n mp3
, and vorbis
.
The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:
\nauto
, 22050
, 32000
, 44100
,\n 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.
\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\nThe number of audio channels in the output file. Valid values include:
\nauto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically detects the number of channels in\n the input file.
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
\nSpecify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
\nauto
: If you specify auto
, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.AAC-LC
: The most common AAC profile. Use for bitrates larger than\n 64 kbps.HE-AAC
: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.
If you specified AAC
for Audio:Codec
, this is the AAC
\n 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.
A section of the response body that provides information about the audio preset\n values.
\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\nThe video codec for the output file. Valid values include H.264
and\n vp8
. You can only specify vp8
when the container type is\n webm
.
\n Profile\n
\nThe H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:
\nbaseline
: The profile most commonly used for videoconferencing and for\n mobile applications.main
: The profile used for standard-definition digital TV\n broadcasts.high
: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.\n Level (H.264 Only)\n
\nThe H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:
\n1
, 1b
, 1.1
, 1.2
, 1.3
,\n 2
, 2.1
, 2.2
, 3
,\n 3.1
, 3.2
, 4
, 4.1
\n MaxReferenceFrames (H.264 Only)\n
\nApplicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:
\n\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)
\n
where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level
object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)
\n MaxBitRate\n
\nThe maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize
. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.
\n BufferSize\n
\nThe maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate
and omit BufferSize
, Elastic Transcoder sets\n BufferSize
to 10 times the value of MaxBitRate
.
The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.
\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\nWhether to use a fixed value for FixedGOP
. Valid values are\n true
and false
:
true
: Elastic Transcoder uses the value of KeyframesMaxDist
for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).false
: The distance between key frames can vary.The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level
and Profile
. If you specify\n auto
, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto
, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:
\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n
\nThe frames per second for the video stream in the output file. Valid values include:
\nauto
, 10
, 15
, 23.97
, 24
,\n 25
, 29.97
, 30
, 60
If you specify auto
, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:
\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)
\n
where:
\nThe maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):
\nIf you specify auto
for FrameRate
, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10
,\n 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
.
To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The width and height of the video in the output file, in pixels. Valid values are\n auto
and width x height:
auto
: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.width x height
: The width and height of the output video\n in pixels.Note the following about specifying the width and height:
\nTo better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The display aspect ratio of the video in the output file. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.
\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n The maximum width of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.
The maximum height of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.
The value that Elastic Transcoder adds to the metadata in the output file.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of the output video:
\n\n
Fit
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without\n exceeding the other value.Fill
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches\n or exceeds the other value. Elastic Transcoder centers the output video and then crops it in\n the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches the output video to match the values that\n you specified for MaxWidth
and MaxHeight
. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.Keep
: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n MaxWidth
and MaxHeight
, Elastic Transcoder crops the output\n video.ShrinkToFit
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth
\n and MaxHeight
.
Id
can be up to 40 characters long. "
},
"MaxWidth": {
"shape_name": "PixelsOrPercent",
"type": "string",
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
"documentation": "\n The maximum width of the watermark in one of the following formats:
MaxWidth
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxWidth
.The maximum height of the watermark in one of the following formats:
MaxHeight
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxHeight
.\n "
},
"SizingPolicy": {
"shape_name": "WatermarkSizingPolicy",
"type": "string",
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
"documentation": "\n A value that controls scaling of the watermark:
MaxWidth
or MaxHeight
without\n exceeding the other value.MaxWidth
and MaxHeight
. If the\n relative proportions of the watermark and the values of MaxWidth
\n and MaxHeight
are different, the watermark will be distorted.MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset
:
The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:
HorizontalAlign
and 5px for\n HorizontalOffset
, the left side of the watermark appears 5 pixels from\n the left border of the output video.\n HorizontalOffset
is only valid when the value of\n HorizontalAlign
is Left
or Right
. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.
Use the value of Target
to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.
The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset
:
VerticalOffset
\n The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:
MaxHeight
.Top
for VerticalAlign
and\n 5px
for VerticalOffset
, the top of the watermark appears 5\n pixels from the top border of the output video.\n VerticalOffset
is only valid when the value of VerticalAlign is Top or\n Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.
\n\nUse the value of Target
to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.
A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity
is float.
Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity
. The .jpg file format doesn't support transparency.
A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset
, VerticalOffset
, MaxWidth
,\n and MaxHeight
:
HorizontalOffset
and\n VerticalOffset
values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n MaxWidth
and MaxHeight
, if specified as a\n percentage, are calculated based on the borders of the video excluding black\n bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.MaxWidth
and\n MaxHeight
, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " }, "documentation": "\nSettings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " } }, "documentation": "\nA section of the response body that provides information about the video preset\n values.
\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\nThe format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\nThe number of seconds between thumbnails. Specify an integer value.
\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\nTo better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format\n width
x height
where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution
object.
To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.
\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\nThe maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of thumbnails:
\n\n
Fit
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding\n the other value. Fill
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth
or MaxHeight
\n settings and matches or exceeds the other value. Elastic Transcoder centers the\n image in thumbnails and then crops in the dimension (if any) that exceeds the\n maximum value.Stretch
: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail MaxWidth
and\n MaxHeight
settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.Keep
: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings, Elastic\n Transcoder crops the thumbnails.ShrinkToFit
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail MaxWidth
and MaxHeight
without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.ShrinkToFill
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings.
A section of the response body that provides information about the thumbnail preset\n values, if any.
\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\nWhether the preset is a default preset provided by Elastic Transcoder\n (System
) or a preset that you have defined (Custom
).
A section of the response body that provides information about the preset that is\n created.
\n " }, "Warning": { "shape_name": "String", "type": "string", "documentation": "\nIf the preset settings don't comply with the standards for the video codec but Elastic Transcoder\n created the preset, this message explains the reason the preset settings don't meet the\n standard. Elastic Transcoder created the preset because the settings might produce acceptable\n output.
\n " } }, "documentation": "\nThe CreatePresetResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\nToo many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe CreatePreset operation creates a preset with settings that you specify.
\nValidationException
) and\n does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly\n compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message\n in the response. This helps you determine whether your settings comply with the H.264\n standard while giving you greater flexibility with respect to the video that Elastic Transcoder\n produces.Elastic Transcoder uses the H.264 video-compression format. For more information, see the International\n Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding\n for generic audiovisual services.
\nThe identifier of the pipeline that you want to delete.
\n ", "required": true, "location": "uri" } }, "documentation": "\nThe DeletePipelineRequest
structure.
The DeletePipelineResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\nThe resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe DeletePipeline operation removes a pipeline.
\n You can only delete a pipeline that has never been used or that is not currently in use\n (doesn't contain any active jobs). If the pipeline is currently in use,\n DeletePipeline
returns an error.
The identifier of the preset for which you want to get detailed information.
\n ", "required": true, "location": "uri" } }, "documentation": "\nThe DeletePresetRequest
structure.
The DeletePresetResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe DeletePreset operation removes a preset that you've added in an AWS region.
\nYou can't delete the default presets that are included with Elastic Transcoder.
\nThe ID of the pipeline for which you want to get job information.
\n ", "required": true, "location": "uri" }, "Ascending": { "shape_name": "Ascending", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n To list jobs in chronological order by the date and time that they were submitted, enter\n true
. To list jobs in reverse chronological order, enter\n false
.
When Elastic Transcoder returns more than one page of results, use pageToken
in\n subsequent GET
requests to get each successive page of results.
The ListJobsByPipelineRequest
structure.
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the job.
\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n The Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket
object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg
, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto
. If you want to specify the frame rate for\n the input file, enter one of the following values:
\n 10
, 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n the frame rate.
This value must be auto
, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto
. If you want to specify the aspect\n ratio for the output file, enter one of the following values:
\n 1:1
, 4:3
, 3:2
, 16:9
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection\n of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto
. If you want to specify whether\n the input file is interlaced, enter one of the following values:
true
, false
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto
. If you want to specify the\n container type for the input file, enter one of the following values:
\n 3gp
, aac
, asf
, avi
, \n divx
, flv
, m4a
, mkv
, \n mov
, mp3
, mp4
, mpeg
, \n mpeg-ps
, mpeg-ts
, mxf
, ogg
, \n vob
, wav
, webm
\n
A section of the request or response body that provides information about the file that\n is being transcoded.
\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nIf you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.
\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nOutput
object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs
\n object.
Information about the output files. We recommend that you use the Outputs
\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs
and Output
syntaxes in\n the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.
\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix
.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name
objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name
, it will appear twice in the file name.
This value must currently be HLSv3
.
For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration
for all of the outputs must be the same.
The status of the job with which the playlist is associated.
\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nInformation that further explains the status.
\n " } }, "documentation": "\n Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts
(MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.
PresetId
for which the value of Container
is ts (MPEG-TS),\n Playlists
contains information about the master playlists that you want\n Elastic Transcoder to create.
We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.
\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n The status of the job: Submitted
, Progressing
, Complete
,\n Canceled
, or Error
.
A section of the response body that provides information about the job that is\n created.
\n " }, "documentation": "\nAn array of Job
objects that are in the specified pipeline.
A value that you use to access the second and subsequent pages of results, if any. When\n the jobs in the specified pipeline fit on one page or when you've reached the last page\n of results, the value of NextPageToken
is null
.
The ListJobsByPipelineResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
\nElastic Transcoder returns all of the jobs currently in the specified pipeline. The\n response body contains one element for each job that satisfies the search criteria.
\nTo get information about all of the jobs associated with the current AWS account that\n have a given status, specify the following status: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
.
To list jobs in chronological order by the date and time that they were submitted, enter\n true
. To list jobs in reverse chronological order, enter\n false
.
When Elastic Transcoder returns more than one page of results, use pageToken
in\n subsequent GET
requests to get each successive page of results.
The ListJobsByStatusRequest
structure.
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the job.
\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n The Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket
object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg
, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto
. If you want to specify the frame rate for\n the input file, enter one of the following values:
\n 10
, 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n the frame rate.
This value must be auto
, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto
. If you want to specify the aspect\n ratio for the output file, enter one of the following values:
\n 1:1
, 4:3
, 3:2
, 16:9
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection\n of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto
. If you want to specify whether\n the input file is interlaced, enter one of the following values:
true
, false
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto
. If you want to specify the\n container type for the input file, enter one of the following values:
\n 3gp
, aac
, asf
, avi
, \n divx
, flv
, m4a
, mkv
, \n mov
, mp3
, mp4
, mpeg
, \n mpeg-ps
, mpeg-ts
, mxf
, ogg
, \n vob
, wav
, webm
\n
A section of the request or response body that provides information about the file that\n is being transcoded.
\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nIf you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.
\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nOutput
object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs
\n object.
Information about the output files. We recommend that you use the Outputs
\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs
and Output
syntaxes in\n the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.
\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix
.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name
objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name
, it will appear twice in the file name.
This value must currently be HLSv3
.
For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration
for all of the outputs must be the same.
The status of the job with which the playlist is associated.
\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nInformation that further explains the status.
\n " } }, "documentation": "\n Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts
(MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.
PresetId
for which the value of Container
is ts (MPEG-TS),\n Playlists
contains information about the master playlists that you want\n Elastic Transcoder to create.
We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.
\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n The status of the job: Submitted
, Progressing
, Complete
,\n Canceled
, or Error
.
A section of the response body that provides information about the job that is\n created.
\n " }, "documentation": "\nAn array of Job
objects that have the specified status.
A value that you use to access the second and subsequent pages of results, if any. When\n the jobs in the specified pipeline fit on one page or when you've reached the last page\n of results, the value of NextPageToken
is null
.
\n The ListJobsByStatusResponse
structure.\n
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ListJobsByStatus operation gets a list of jobs that have a specified status. The\n response body contains one element for each job that satisfies the search criteria.
\nTo list pipelines in chronological order by the date and time that they were created, enter\n true
. To list pipelines in reverse chronological order, enter\n false
.
When Elastic Transcoder returns more than one page of results, use pageToken
in\n subsequent GET
requests to get each successive page of results.
The ListPipelineRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.The pipeline (queue) that is used to manage jobs.
\n " }, "documentation": "\nAn array of Pipeline
objects.
A value that you use to access the second and subsequent pages of results, if any. When\n the pipelines fit on one page or when you've reached the last page\n of results, the value of NextPageToken
is null
.
A list of the pipelines associated with the current AWS account.
\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\nOne or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ListPipelines operation gets a list of the pipelines associated with the current AWS\n account.
\nTo list presets in chronological order by the date and time that they were created, enter\n true
. To list presets in reverse chronological order, enter\n false
.
When Elastic Transcoder returns more than one page of results, use pageToken
in\n subsequent GET
requests to get each successive page of results.
The ListPresetsRequest
structure.
Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the preset.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the preset.
\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nA description of the preset.
\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\nThe container type for the output file. Valid values include mp3
,\n mp4
, ogg
, ts
, and webm
.
The audio codec for the output file. Valid values include aac
, \n mp3
, and vorbis
.
The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:
\nauto
, 22050
, 32000
, 44100
,\n 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.
\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\nThe number of audio channels in the output file. Valid values include:
\nauto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically detects the number of channels in\n the input file.
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
\nSpecify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
\nauto
: If you specify auto
, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.AAC-LC
: The most common AAC profile. Use for bitrates larger than\n 64 kbps.HE-AAC
: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.
If you specified AAC
for Audio:Codec
, this is the AAC
\n 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.
A section of the response body that provides information about the audio preset\n values.
\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\nThe video codec for the output file. Valid values include H.264
and\n vp8
. You can only specify vp8
when the container type is\n webm
.
\n Profile\n
\nThe H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:
\nbaseline
: The profile most commonly used for videoconferencing and for\n mobile applications.main
: The profile used for standard-definition digital TV\n broadcasts.high
: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.\n Level (H.264 Only)\n
\nThe H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:
\n1
, 1b
, 1.1
, 1.2
, 1.3
,\n 2
, 2.1
, 2.2
, 3
,\n 3.1
, 3.2
, 4
, 4.1
\n MaxReferenceFrames (H.264 Only)\n
\nApplicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:
\n\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)
\n
where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level
object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)
\n MaxBitRate\n
\nThe maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize
. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.
\n BufferSize\n
\nThe maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate
and omit BufferSize
, Elastic Transcoder sets\n BufferSize
to 10 times the value of MaxBitRate
.
The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.
\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\nWhether to use a fixed value for FixedGOP
. Valid values are\n true
and false
:
true
: Elastic Transcoder uses the value of KeyframesMaxDist
for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).false
: The distance between key frames can vary.The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level
and Profile
. If you specify\n auto
, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto
, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:
\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n
\nThe frames per second for the video stream in the output file. Valid values include:
\nauto
, 10
, 15
, 23.97
, 24
,\n 25
, 29.97
, 30
, 60
If you specify auto
, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:
\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)
\n
where:
\nThe maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):
\nIf you specify auto
for FrameRate
, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10
,\n 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
.
To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The width and height of the video in the output file, in pixels. Valid values are\n auto
and width x height:
auto
: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.width x height
: The width and height of the output video\n in pixels.Note the following about specifying the width and height:
\nTo better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The display aspect ratio of the video in the output file. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.
\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n The maximum width of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.
The maximum height of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.
The value that Elastic Transcoder adds to the metadata in the output file.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of the output video:
\n\n
Fit
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without\n exceeding the other value.Fill
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches\n or exceeds the other value. Elastic Transcoder centers the output video and then crops it in\n the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches the output video to match the values that\n you specified for MaxWidth
and MaxHeight
. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.Keep
: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n MaxWidth
and MaxHeight
, Elastic Transcoder crops the output\n video.ShrinkToFit
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth
\n and MaxHeight
.
Id
can be up to 40 characters long. "
},
"MaxWidth": {
"shape_name": "PixelsOrPercent",
"type": "string",
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
"documentation": "\n The maximum width of the watermark in one of the following formats:
MaxWidth
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxWidth
.The maximum height of the watermark in one of the following formats:
MaxHeight
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxHeight
.\n "
},
"SizingPolicy": {
"shape_name": "WatermarkSizingPolicy",
"type": "string",
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
"documentation": "\n A value that controls scaling of the watermark:
MaxWidth
or MaxHeight
without\n exceeding the other value.MaxWidth
and MaxHeight
. If the\n relative proportions of the watermark and the values of MaxWidth
\n and MaxHeight
are different, the watermark will be distorted.MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset
:
The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:
HorizontalAlign
and 5px for\n HorizontalOffset
, the left side of the watermark appears 5 pixels from\n the left border of the output video.\n HorizontalOffset
is only valid when the value of\n HorizontalAlign
is Left
or Right
. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.
Use the value of Target
to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.
The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset
:
VerticalOffset
\n The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:
MaxHeight
.Top
for VerticalAlign
and\n 5px
for VerticalOffset
, the top of the watermark appears 5\n pixels from the top border of the output video.\n VerticalOffset
is only valid when the value of VerticalAlign is Top or\n Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.
\n\nUse the value of Target
to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.
A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity
is float.
Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity
. The .jpg file format doesn't support transparency.
A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset
, VerticalOffset
, MaxWidth
,\n and MaxHeight
:
HorizontalOffset
and\n VerticalOffset
values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n MaxWidth
and MaxHeight
, if specified as a\n percentage, are calculated based on the borders of the video excluding black\n bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.MaxWidth
and\n MaxHeight
, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " }, "documentation": "\nSettings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " } }, "documentation": "\nA section of the response body that provides information about the video preset\n values.
\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\nThe format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\nThe number of seconds between thumbnails. Specify an integer value.
\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\nTo better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format\n width
x height
where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution
object.
To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.
\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\nThe maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of thumbnails:
\n\n
Fit
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding\n the other value. Fill
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth
or MaxHeight
\n settings and matches or exceeds the other value. Elastic Transcoder centers the\n image in thumbnails and then crops in the dimension (if any) that exceeds the\n maximum value.Stretch
: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail MaxWidth
and\n MaxHeight
settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.Keep
: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings, Elastic\n Transcoder crops the thumbnails.ShrinkToFit
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail MaxWidth
and MaxHeight
without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.ShrinkToFill
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings.
A section of the response body that provides information about the thumbnail preset\n values, if any.
\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\nWhether the preset is a default preset provided by Elastic Transcoder\n (System
) or a preset that you have defined (Custom
).
Presets are templates that contain most of the settings for transcoding media files from\n one format to another. Elastic Transcoder includes some default presets for common formats, for\n example, several iPod and iPhone versions. You can also create your own presets for\n formats that aren't included among the default presets. You specify which preset you\n want to use when you create a job.
\n " }, "documentation": "\nAn array of Preset
objects.
A value that you use to access the second and subsequent pages of results, if any. When\n the presets fit on one page or when you've reached the last page\n of results, the value of NextPageToken
is null
.
The ListPresetsResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ListPresets operation gets a list of the default presets included with Elastic Transcoder and the\n presets that you've added in an AWS region.
\nThe identifier of the job for which you want to get detailed information.
\n ", "required": true, "location": "uri" } }, "documentation": "\nThe ReadJobRequest
structure.
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the job.
\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n The Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket
object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg
, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto
. If you want to specify the frame rate for\n the input file, enter one of the following values:
\n 10
, 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n the frame rate.
This value must be auto
, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto
. If you want to specify the aspect\n ratio for the output file, enter one of the following values:
\n 1:1
, 4:3
, 3:2
, 16:9
\n
If you specify a value other than auto
, Elastic Transcoder disables automatic detection\n of the aspect ratio.
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto
. If you want to specify whether\n the input file is interlaced, enter one of the following values:
true
, false
If you specify a value other than auto
, Elastic Transcoder disables automatic detection of\n interlacing.
The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto
. If you want to specify the\n container type for the input file, enter one of the following values:
\n 3gp
, aac
, asf
, avi
, \n divx
, flv
, m4a
, mkv
, \n mov
, mp3
, mp4
, mpeg
, \n mpeg-ps
, mpeg-ts
, mxf
, ogg
, \n vob
, wav
, webm
\n
A section of the request or response body that provides information about the file that\n is being transcoded.
\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nIf you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.
\nA sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.
\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket
object in the pipeline that is specified by\n the pipeline ID.
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.
\nIf you don't want Elastic Transcoder to create thumbnails, specify \"\".
\nIf you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:
\n\n {count}
(Required): If you want to create thumbnails, you\n must include {count}
in the ThumbnailPattern
object.\n Wherever you specify {count}
, Elastic Transcoder adds a five-digit sequence\n number (beginning with 00001) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file.
{resolution}
but you\n omit {count}
, Elastic Transcoder returns a validation error and does not create\n the job.\n Literal values (Optional): You can specify literal values anywhere in the\n ThumbnailPattern
object. For example, you can include them as a\n file name prefix or as a delimiter between {resolution}
and\n {count}
.
\n {resolution}
(Optional): If you want Elastic Transcoder to include the\n resolution in the file name, include {resolution}
in the\n ThumbnailPattern
object.
When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID
value of\n CreateJobOutput
. Elastic Transcoder also appends the applicable file name\n extension.
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:
\nauto
, 0
, 90
, 180
,\n 270
The value auto
generally works only if the file that you're transcoding\n contains rotation metadata.
The value of the Id
object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets
.
PresetId
for which the value of Container
is\n ts
(MPEG-TS), SegmentDuration
is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration
, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys
.
The status of one output in a job. If you specified only one output for the job,\n Outputs:Status
is always the same as Job:Status
. If you\n specified more than one output:
Job:Status
and Outputs:Status
for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.Outputs:Status
for that output and Job:Status
both\n change to Progressing. For each output, the value of Outputs:Status
\n remains Submitted until Elastic Transcoder starts to process the output.Job:Status
changes\n to Complete only if Outputs:Status
for all of the outputs is\n Complete
. If Outputs:Status
for one or more\n outputs is Error
, the terminal status for Job:Status
\n is also Error
.Status
is one of the following: Submitted
,\n Progressing
, Complete
, Canceled
, or\n Error
. \n "
},
"StatusDetail": {
"shape_name": "Description",
"type": "string",
"min_length": 0,
"max_length": 255,
"documentation": "\n Information that further explains Status
.
Duration of the output file, in seconds.
\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nSpecifies the width of the output file in pixels.
\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\nHeight of the output file, in pixels.
\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.
\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline
; the Input Bucket
object in that pipeline\n identifies the bucket.
If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
\n " } }, "documentation": "\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\n " }, "documentation": "\nInformation about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset
for the\n current output.
Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.
\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\nA policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.
\n\n
Replace:
The specified album art will replace any existing album art.Prepend:
The specified album art will be placed in front of any existing \n album art.Append:
The specified album art will be placed after any existing album art.Fallback:
If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId
; the \n InputBucket
object in that pipeline identifies the bucket.
If the file name includes a prefix, for example, cooking/pie.jpg
,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.
The maximum width of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.
The maximum height of the output album art in pixels. If you specify auto
, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.
Specify one of the following values to control scaling of the output album art:
\n\n
Fit:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without \n exceeding the other value.Fill:
Elastic Transcoder scales the output art so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches or \n exceeds the other value. Elastic Transcoder centers the output art and then crops it in the \n dimension (if any) that exceeds the maximum value. Stretch:
Elastic Transcoder stretches the output art to match the values that you\n specified for MaxWidth
and MaxHeight
. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.Keep:
Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for MaxWidth
and \n MaxHeight
, Elastic Transcoder crops the output art.ShrinkToFit:
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.ShrinkToFill
Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of MaxWidth
and \n MaxHeight
without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth
and \n MaxHeight
.
The format of album art, if any. Valid formats are .jpg
and .png
.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.
\nTo remove artwork or leave the artwork empty, you can either set Artwork
\n to null, or set the Merge Policy
to \"Replace\" and use an empty\n Artwork
array.
To pass through existing artwork unchanged, set the Merge Policy
to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork
array.
The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg
and .png
The album art to be associated with the output file, if any.
\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nThe duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.
\nIf you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.
\n " } }, "documentation": "\nSettings that determine when a clip begins and how long it lasts.
\n " } }, "documentation": "\nSettings for one clip in a composition. All jobs in a playlist must have the same clip settings.
\n " }, "documentation": "\nYou can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.
\n " }, "Captions": { "shape_name": "Captions", "type": "structure", "members": { "MergePolicy": { "shape_name": "CaptionMergePolicy", "type": "string", "pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)", "documentation": "\nA policy that determines how Elastic Transcoder handles the existence of multiple captions.
\nMergeOverride: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the\n embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded\n and sidecar captions into outputs. If captions for a language are embedded in the input\n file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the\n sidecar captions for that language. If
Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources
.
MergePolicy
cannot be null.
The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.
\n " }, "Language": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nA string that specifies the language of the caption. Specify this as one of:
\n2-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 \n 639-1 codes.
\n " }, "TimeOffset": { "shape_name": "TimeOffset", "type": "string", "pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\nFor clip generation or captions that do not start at the same time\n as the associated video file, the TimeOffset
tells Elastic Transcoder how much of the video to encode\n before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
\n " }, "Label": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.
\n " } }, "documentation": "\nA source file for the input sidecar captions used during the transcoding\n process.
\n " }, "max_length": 20, "documentation": "\nSource files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources
blank.
The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.
\nValid Embedded Caption Formats:
\nFor MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\nThe prefix for caption filenames, in the form description-{language}
, where:
{language}
is a literal value that Elastic Transcoder replaces with the two- or three-letter\n 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\n appends \"{language}
\" to the value that you specify for the description. In addition,\n 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\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
\n " } }, "documentation": "\nThe file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " }, "max_length": 4, "documentation": "\nThe array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.
\n " } }, "documentation": "\nYou can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another.\n All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\nEmbedded: Embedded captions\n are included in the same file as the audio and video. Elastic Transcoder supports\n only one embedded caption per language, to a maximum of 300 embedded captions per file.
\nValid input values include: CEA-608 (EIA-608
, first non-empty channel only),\n CEA-708 (EIA-708
, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
\nSidecar: Sidecar captions are kept in a\n separate metadata file from the audio and video data. Sidecar captions require a player\n that is capable of understanding the relationship between the video file and the sidecar\n file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar\n captions per file.
\nValid input values include: dfxp
(first div element only),\n ebu-tt
, scc
, smpt
, srt
,\n ttml
(first div element only), and webvtt
Valid outputs include: dfxp
(first div element only), scc
,\n srt
, and webvtt
.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
\nElastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures\n as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does\n not preserve text formatting (for example, italics) during the transcoding process.
\nTo remove captions or leave the captions empty, set Captions
to null. To pass through\n existing captions unchanged, set the MergePolicy
to MergeRetain
,\n and pass in a null CaptionSources
array.
For more information on embedded files, see the Subtitles Wikipedia page.
\nFor more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.
\n " } }, "documentation": "\nOutput
object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs
\n object.
Information about the output files. We recommend that you use the Outputs
\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs
and Output
syntaxes in\n the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.
\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\nThe value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix
.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name
objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name
, it will appear twice in the file name.
This value must currently be HLSv3
.
For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration
for all of the outputs must be the same.
The status of the job with which the playlist is associated.
\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nInformation that further explains the status.
\n " } }, "documentation": "\n Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts
(MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.
PresetId
for which the value of Container
is ts (MPEG-TS),\n Playlists
contains information about the master playlists that you want\n Elastic Transcoder to create.
We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.
\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n The status of the job: Submitted
, Progressing
, Complete
,\n Canceled
, or Error
.
A section of the response body that provides information about the job.
\n " } }, "documentation": "\nThe ReadJobResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ReadJob operation returns detailed information about a job.
\nThe identifier of the pipeline to read.
\n ", "required": true, "location": "uri" } }, "documentation": "\nThe ReadPipelineRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.A section of the response body that provides information about the pipeline.
\n " } }, "documentation": "\nThe ReadPipelineResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ReadPipeline operation gets detailed information about a pipeline.
\nThe identifier of the preset for which you want to get detailed information.
\n ", "required": true, "location": "uri" } }, "documentation": "\nThe ReadPresetRequest
structure.
Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the preset.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the preset.
\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\nA description of the preset.
\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\nThe container type for the output file. Valid values include mp3
,\n mp4
, ogg
, ts
, and webm
.
The audio codec for the output file. Valid values include aac
, \n mp3
, and vorbis
.
The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:
\nauto
, 22050
, 32000
, 44100
,\n 48000
, 96000
If you specify auto
, Elastic Transcoder automatically detects the sample rate.
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.
\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\nThe number of audio channels in the output file. Valid values include:
\nauto
, 0
, 1
, 2
If you specify auto
, Elastic Transcoder automatically detects the number of channels in\n the input file.
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
\nSpecify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
\nauto
: If you specify auto
, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.AAC-LC
: The most common AAC profile. Use for bitrates larger than\n 64 kbps.HE-AAC
: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.HE-AACv2
: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.
If you specified AAC
for Audio:Codec
, this is the AAC
\n 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.
A section of the response body that provides information about the audio preset\n values.
\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\nThe video codec for the output file. Valid values include H.264
and\n vp8
. You can only specify vp8
when the container type is\n webm
.
\n Profile\n
\nThe H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:
\nbaseline
: The profile most commonly used for videoconferencing and for\n mobile applications.main
: The profile used for standard-definition digital TV\n broadcasts.high
: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.\n Level (H.264 Only)\n
\nThe H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:
\n1
, 1b
, 1.1
, 1.2
, 1.3
,\n 2
, 2.1
, 2.2
, 3
,\n 3.1
, 3.2
, 4
, 4.1
\n MaxReferenceFrames (H.264 Only)\n
\nApplicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:
\n\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)
\n
where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level
object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)
\n MaxBitRate\n
\nThe maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize
. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.
\n BufferSize\n
\nThe maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate
and omit BufferSize
, Elastic Transcoder sets\n BufferSize
to 10 times the value of MaxBitRate
.
The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.
\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\nWhether to use a fixed value for FixedGOP
. Valid values are\n true
and false
:
true
: Elastic Transcoder uses the value of KeyframesMaxDist
for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).false
: The distance between key frames can vary.The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level
and Profile
. If you specify\n auto
, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto
, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:
\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n
\nThe frames per second for the video stream in the output file. Valid values include:
\nauto
, 10
, 15
, 23.97
, 24
,\n 25
, 29.97
, 30
, 60
If you specify auto
, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:
\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)
\n
where:
\nThe maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):
\nIf you specify auto
for FrameRate
, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10
,\n 15
, 23.97
, 24
, 25
,\n 29.97
, 30
, 60
.
To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The width and height of the video in the output file, in pixels. Valid values are\n auto
and width x height:
auto
: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.width x height
: The width and height of the output video\n in pixels.Note the following about specifying the width and height:
\nTo better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, PaddingPolicy
, and\n DisplayAspectRatio
instead of Resolution
and\n AspectRatio
. The two groups of settings are mutually exclusive. Do\n not use them together.
The display aspect ratio of the video in the output file. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.
\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n The maximum width of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.
The maximum height of the output video in pixels. If you specify auto
, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.
The value that Elastic Transcoder adds to the metadata in the output file.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of the output video:
\n\n
Fit
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
without\n exceeding the other value.Fill
: Elastic Transcoder scales the output video so it matches the value that you\n specified in either MaxWidth
or MaxHeight
and matches\n or exceeds the other value. Elastic Transcoder centers the output video and then crops it in\n the dimension (if any) that exceeds the maximum value.Stretch
: Elastic Transcoder stretches the output video to match the values that\n you specified for MaxWidth
and MaxHeight
. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.Keep
: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n MaxWidth
and MaxHeight
, Elastic Transcoder crops the output\n video.ShrinkToFit
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.ShrinkToFill
: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth
\n and MaxHeight
.
Id
can be up to 40 characters long. "
},
"MaxWidth": {
"shape_name": "PixelsOrPercent",
"type": "string",
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
"documentation": "\n The maximum width of the watermark in one of the following formats:
MaxWidth
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxWidth
.The maximum height of the watermark in one of the following formats:
MaxHeight
.Target
to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.MaxHeight
.\n "
},
"SizingPolicy": {
"shape_name": "WatermarkSizingPolicy",
"type": "string",
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
"documentation": "\n A value that controls scaling of the watermark:
MaxWidth
or MaxHeight
without\n exceeding the other value.MaxWidth
and MaxHeight
. If the\n relative proportions of the watermark and the values of MaxWidth
\n and MaxHeight
are different, the watermark will be distorted.MaxWidth
and MaxHeight
without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset
:
The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:
HorizontalAlign
and 5px for\n HorizontalOffset
, the left side of the watermark appears 5 pixels from\n the left border of the output video.\n HorizontalOffset
is only valid when the value of\n HorizontalAlign
is Left
or Right
. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.
Use the value of Target
to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.
The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset
:
VerticalOffset
\n The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:
MaxHeight
.Top
for VerticalAlign
and\n 5px
for VerticalOffset
, the top of the watermark appears 5\n pixels from the top border of the output video.\n VerticalOffset
is only valid when the value of VerticalAlign is Top or\n Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.
\n\nUse the value of Target
to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.
A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity
is float.
Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity
. The .jpg file format doesn't support transparency.
A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset
, VerticalOffset
, MaxWidth
,\n and MaxHeight
:
HorizontalOffset
and\n VerticalOffset
values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n MaxWidth
and MaxHeight
, if specified as a\n percentage, are calculated based on the borders of the video excluding black\n bars added by Elastic Transcoder, if any.HorizontalOffset
and VerticalOffset
\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.MaxWidth
and\n MaxHeight
, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " }, "documentation": "\nSettings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.
\nWatermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.
\n " } }, "documentation": "\nA section of the response body that provides information about the video preset\n values.
\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\nThe format of thumbnails, if any. Valid values are jpg
and png
.
You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\nThe number of seconds between thumbnails. Specify an integer value.
\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\nTo better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels. Specify a value in the format\n width
x height
where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution
object.
To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth
, MaxHeight
,\n SizingPolicy
, and PaddingPolicy
instead of\n Resolution
and AspectRatio
. The two groups of settings\n are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
\nauto
, 1:1
, 4:3
, 3:2
,\n 16:9
If you specify auto
, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.
\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\nThe maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.
\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\nSpecify one of the following values to control scaling of thumbnails:
\n\n
Fit
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding\n the other value. Fill
: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail MaxWidth
or MaxHeight
\n settings and matches or exceeds the other value. Elastic Transcoder centers the\n image in thumbnails and then crops in the dimension (if any) that exceeds the\n maximum value.Stretch
: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail MaxWidth
and\n MaxHeight
settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.Keep
: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings, Elastic\n Transcoder crops the thumbnails.ShrinkToFit
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail MaxWidth
and MaxHeight
without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.ShrinkToFill
: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n MaxWidth
and MaxHeight
without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.When you set PaddingPolicy
to Pad
, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth
and MaxHeight
settings.
A section of the response body that provides information about the thumbnail preset\n values, if any.
\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\nWhether the preset is a default preset provided by Elastic Transcoder\n (System
) or a preset that you have defined (Custom
).
A section of the response body that provides information about the preset.
\n " } }, "documentation": "\nThe ReadPresetResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe ReadPreset operation gets detailed information about a preset.
\nThe IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to\n test.
\n ", "required": true }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket that contains media files to be transcoded. The action attempts to read\n from this bucket.
\n ", "required": true }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to\n read from this bucket.
\n ", "required": true }, "Topics": { "shape_name": "SnsTopics", "type": "list", "members": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": null }, "max_length": 30, "documentation": "\nThe ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test\n notification to.
\n ", "required": true } }, "documentation": "\n The TestRoleRequest
structure.
If the operation is successful, this value is true
; otherwise, the value is\n false
.
If the Success
element contains false
, this value is an array\n of one or more error messages that were generated during the test process.
The TestRoleResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe TestRole operation tests the IAM role used to create the pipeline.
\nThe TestRole
action lets you determine whether the IAM role you are using\n has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding\n process. The action attempts to assume the specified IAM role, checks read access to the\n input and output buckets, and tries to send a test notification to Amazon SNS topics\n that you specify.
The ID of the pipeline that you want to update.
\n ", "required": true, "location": "uri" }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you saved the media files that you want to transcode and\n the graphics that you want to use as watermarks.
\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\nThe IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
The optional ContentConfig
object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.
If you specify values for ContentConfig
, you must also specify values for\n ThumbnailConfig
.
If you specify values for ContentConfig
and ThumbnailConfig
,\n omit the OutputBucket
object.
Grantee
object: Grantee
object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. For more information about canonical user\n IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage\n Service Developer Guide. For more information about using CloudFront origin\n access identities to require that users use CloudFront URLs instead of\n Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to\n Your Amazon S3 Content. Grantee
object is the registered\n email address of an AWS account.Grantee
object is one of the\n following predefined Amazon S3 groups: AllUsers
,\n AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include: READ
: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the video files and playlists that it stores in your Amazon S3 bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
The ThumbnailConfig
object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.
If you specify values for ContentConfig
, you must also specify values for\n ThumbnailConfig
even if you don't want to create thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig
,\n omit the OutputBucket
object.
Permissions
object specifies which\n users and/or predefined Amazon S3 groups you want to have access to thumbnail files,\n and the type of access you want them to have. You can grant permissions to a maximum\n of 30 users and/or predefined Amazon S3 groups.Grantee
object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. Grantee
object is the registered\n email address of an AWS account. Grantee
object is one of the\n following predefined Amazon S3 groups: AllUsers
,\n AuthenticatedUsers
, or LogDelivery
.Grantee
. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include: READ
: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP
: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions for the\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.The UpdatePipelineRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.The pipeline (queue) that is used to manage jobs.
\n ", "required": true } }, "documentation": "\nWhen you update a pipeline, Elastic Transcoder returns the values that you specified in the request.\n
\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\nOne or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\nThe resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.
\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\n Use the UpdatePipeline
operation to update settings for a pipeline.\n
The identifier of the pipeline for which you want to change notification settings.
\n ", "required": true, "location": "uri" }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job\n status.
\nThe UpdatePipelineNotificationsRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.A section of the response body that provides information about the pipeline.
\n " } }, "documentation": "\nThe UpdatePipelineNotificationsResponse
structure.
One or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\nThe resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nWith the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)\n notifications for a pipeline.
\nWhen you update notifications for a pipeline, Elastic Transcoder returns the values that you specified\n in the request.
\nThe identifier of the pipeline to update.
\n ", "required": true, "location": "uri" }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe desired status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The UpdatePipelineStatusRequest
structure.
The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.
\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) for the pipeline.
\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\nThe name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.
\nConstraints: Maximum 40 characters
\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\nThe current status of the pipeline:
\nActive
: The pipeline is processing jobs.Paused
: The pipeline is not currently processing jobs.The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.
\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\nThe Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig
and ThumbnailConfig
.
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.
\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.
\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\nThe Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
\n " } }, "documentation": "\nThe Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nThe Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Grantee
\n object: Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n transcoded files and playlists.Access
: The permission that you want to give to the AWS user\n that is listed in Grantee
. Valid values include: READ
: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ
,\n READ_ACP
, and WRITE_ACP
permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:
ContentConfig
and ThumbnailConfig
instead. \n "
},
"StorageClass": {
"shape_name": "StorageClass",
"type": "string",
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
"documentation": "\n The Amazon S3 storage class, Standard
or ReducedRedundancy
,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.
The type of value that appears in the Grantee object:
Canonical
: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. Email
: The registered email address of an AWS account.Group
: One of the following predefined Amazon S3 groups:\n AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.
\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\nThe permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
READ
: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP
: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP
: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.The Permission
structure.
Optional. The Permissions
object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.
If you include Permissions
, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role
. If you want that user to have full control, you must explicitly\n grant full control to the user.
If you omit Permissions
, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role
, and grants no\n other permissions to any other user or group.
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig
and\n ThumbnailConfig
, or you specify OutputBucket
.
Bucket
: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. Permissions
: A list of the users and/or predefined Amazon S3 groups you\n want to have access to thumbnail files, and the type of access that you want them to\n have. Canonical
: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. Email
: The registered email address of an AWS\n account.Group
: One of the following predefined Amazon S3\n groups: AllUsers
, AuthenticatedUsers
, or\n LogDelivery
.Grantee
: The AWS user or group that you want to have access to\n thumbnail files.READ
: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.READ_ACP
: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.WRITE_ACP
: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.FULL_CONTROL
: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.StorageClass
: The Amazon S3 storage class, Standard
or\n ReducedRedundancy
, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.A section of the response body that provides information about the pipeline.
\n " } }, "documentation": "When you update status for a pipeline,\n Elastic Transcoder returns the values that you specified in the request." }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\nOne or more required parameter values were not provided in the request.
\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\nThe requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.
\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\nThe resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.
\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\nGeneral authentication failure. The request was not signed correctly.
\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\nElastic Transcoder encountered an unexpected exception while trying to fulfill the request.
\n " } ], "documentation": "\nThe UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline\n stops or restarts the processing of jobs.
\nChanging the pipeline status is useful if you want to cancel one or more jobs. You can't\n cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which\n you submitted the jobs, you have more time to get the job IDs for the jobs that you want\n to cancel, and to send a CancelJob request.
\n