General authentication failure. The request was not signed correctly.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.elastictranscoder#Artwork": { "type": "structure", "members": { "InputKey": { "target": "com.amazonaws.elastictranscoder#WatermarkKey", "traits": { "smithy.api#documentation": "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\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.
\n 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.
\n 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.
\n 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.
\n 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.
\n 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 encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
" } } }, "traits": { "smithy.api#documentation": "The file to be used as album art. There can be multiple artworks associated with an \n audio file, 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.
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:
\n\n auto: If you specify auto, Elastic Transcoder selects\n the profile based on the bit rate selected for the output file.
\n AAC-LC: The most common AAC profile. Use for bit rates larger than\n 64 kbps.
\n HE-AAC: Not supported on some older players and devices.\n Use for bit rates between 40 and 80 kbps.
\n HE-AACv2: Not supported on some players and devices.\n Use for bit rates less than 48 kbps.
All outputs in a Smooth playlist must have the same value for Profile.
If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your \n presets to use AAC-LC. You can change the value as required.
\nYou can only choose an audio bit depth when you specify flac or \n pcm for the value of Audio:Codec.
The bit depth of a sample is how many bits of information are included in the \n audio samples. The higher the bit depth, the better the audio, but the larger the file.
\nValid values are 16 and 24.
The most common bit depth is 24.
You can only choose an audio bit order when you specify \n pcm for the value of Audio:Codec.
The order the bits of a PCM sample are stored in.
\nThe supported value is LittleEndian.
You can only choose whether an audio sample is signed when you specify \n pcm for the value of Audio:Codec.
Whether audio samples are represented with negative and positive numbers (signed) or \n only positive numbers (unsigned).
\nThe supported value is Signed.
Options associated with your audio codec.
" } }, "com.amazonaws.elastictranscoder#AudioCodecProfile": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)" } }, "com.amazonaws.elastictranscoder#AudioPackingMode": { "type": "string", "traits": { "smithy.api#pattern": "(^SingleTrack$)|(^OneChannelPerTrack$)|(^OneChannelPerTrackWithMosTo8Tracks$)" } }, "com.amazonaws.elastictranscoder#AudioParameters": { "type": "structure", "members": { "Codec": { "target": "com.amazonaws.elastictranscoder#AudioCodec", "traits": { "smithy.api#documentation": "The audio codec for the output file. Valid values include aac, \n flac, mp2, mp3, pcm, \n and vorbis.
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
\n\n auto, 22050, 32000, 44100,\n 48000, 96000\n
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.
" } }, "Channels": { "target": "com.amazonaws.elastictranscoder#AudioChannels", "traits": { "smithy.api#documentation": "The number of audio channels in the output file. The following values are valid:
\n\n auto, 0, 1, 2\n
One channel carries the information played by a single speaker. For example, a stereo\n track with two channels sends one channel to the left speaker, and the other\n channel to the right speaker. The output channels are organized into tracks.\n If you want Elastic Transcoder to automatically detect the number\n of audio channels in the input file and use that value for the output file, select\n auto.
The output of a specific channel value and inputs are as follows:
\n\n\n auto\n channel specified, with any input: Pass through up to eight input channels.
\n 0\n channels specified, with any input: Audio omitted from the output.
\n 1\n channel specified, with at least one input channel: Mono sound.
\n 2\n channels specified, with any input: Two identical mono channels or stereo. For more\n information about tracks, see Audio:AudioPackingMode.\n
For more information about how Elastic Transcoder organizes channels and tracks, see\n Audio:AudioPackingMode.
The method of organizing audio channels and tracks. Use Audio:Channels to\n specify the number of channels in your output, and Audio:AudioPackingMode\n to specify the number of tracks and their relation to the channels. If you do not specify\n an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.
The following values are valid:
\n\n SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks\n
When you specify SingleTrack, Elastic Transcoder creates a single track for your output. \n The track can have up to eight channels. Use SingleTrack for all non-mxf\n containers.
The outputs of SingleTrack for a specific channel value and inputs \n are as follows:
\n 0 \n channels with any input: Audio omitted from the output
\n 1, 2, or auto \n channels with no audio input: Audio omitted from the output
\n 1 \n channel with any input with audio: One track with one channel, downmixed if necessary
\n 2 \n channels with one track with one channel: One track with two identical channels
\n 2 or auto \n channels with two tracks with one channel each: One track with two channels
\n 2 or auto \n channels with one track with two channels: One track with two channels
\n 2 \n channels with one track with multiple channels: One track with two channels
\n auto \n channels with one track with one channel: One track with one channel
\n auto \n channels with one track with multiple channels: One track with multiple channels
When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output\n can have up to eight single-channel tracks.
The outputs of OneChannelPerTrack for a specific channel value and inputs\n are as follows:
\n 0 \n channels with any input: Audio omitted from the output
\n 1, 2, or auto \n channels with no audio input: Audio omitted from the output
\n 1 \n channel with any input with audio: One track with one channel, downmixed if necessary
\n 2 \n channels with one track with one channel: Two tracks with one identical channel each
\n 2 or auto \n channels with two tracks with one channel each: Two tracks with one channel each
\n 2 or auto \n channels with one track with two channels: Two tracks with one channel each
\n 2 \n channels with one track with multiple channels: Two tracks with one channel each
\n auto \n channels with one track with one channel: One track with one channel
\n auto \n channels with one track with multiple channels: Up to eight tracks with one channel each
When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel \n tracks for your output. All tracks that do not contain audio data from an input channel are\n MOS, or Mit Out Sound, tracks.
The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs\n are as follows:
\n 0 \n channels with any input: Audio omitted from the output
\n 1, 2, or auto \n channels with no audio input: Audio omitted from the output
\n 1 \n channel with any input with audio: One track with one channel, \n downmixed if necessary, plus six MOS tracks
\n 2 \n channels with one track with one channel: Two tracks with one \n identical channel each, plus six MOS tracks
\n 2 or auto \n channels with two tracks with one channel each: Two tracks with \n one channel each, plus six MOS tracks
\n 2 or auto \n channels with one track with two channels: Two tracks with one \n channel each, plus six MOS tracks
\n 2 \n channels with one track with multiple channels: Two tracks with \n one channel each, plus six MOS tracks
\n auto \n channels with one track with one channel: One track with one \n channel, plus seven MOS tracks
\n auto \n channels with one track with multiple channels: Up to eight \n tracks with one channel each, plus MOS tracks\n until there are eight tracks in all
If you specified AAC for Audio:Codec, this is the AAC \n compression profile to use. Valid values include:
\n auto, AAC-LC, HE-AAC, HE-AACv2\n
If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.
Parameters required for transcoding audio.
" } }, "com.amazonaws.elastictranscoder#AudioSampleRate": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)|(^192000$)" } }, "com.amazonaws.elastictranscoder#AudioSigned": { "type": "string", "traits": { "smithy.api#pattern": "(^Unsigned$)|(^Signed$)" } }, "com.amazonaws.elastictranscoder#Base64EncodedString": { "type": "string", "traits": { "smithy.api#pattern": "^$|(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" } }, "com.amazonaws.elastictranscoder#BucketName": { "type": "string", "traits": { "smithy.api#pattern": "^(\\w|\\.|-){1,255}$" } }, "com.amazonaws.elastictranscoder#CancelJob": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#CancelJobRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#CancelJobResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceInUseException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The CancelJob operation cancels an unfinished job.
\nYou can only cancel a job that has a status of Submitted. 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 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.
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
\n\n Valid Embedded Caption Formats:\n
\n\n for FLAC: None
\n\n For MP3: None
\n\n For MP4: mov-text
\n\n For MPEG-TS: None
\n\n For ogg: None
\n\n For webm: None
\n\n Valid Sidecar Caption Formats: Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. \n If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.
\n\n For FMP4: dfxp
\n\n Non-FMP4 outputs: All sidecar types
\n\n fmp4 captions have an extension of .ismt\n
The prefix for caption filenames, in the form description-{language}, where:
\n description is a description of the video.
\n\n {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 \"Sydney-{language}-sunrise\", \n and the language of the captions is English (en), the name of the first caption file is be \n Sydney-en-sunrise00000.srt.
" } }, "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { "smithy.api#documentation": "The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
" } } }, "traits": { "smithy.api#documentation": "The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
" } }, "com.amazonaws.elastictranscoder#CaptionFormatFormat": { "type": "string", "traits": { "smithy.api#pattern": "(^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)|(^cea-708$)" } }, "com.amazonaws.elastictranscoder#CaptionFormatPattern": { "type": "string", "traits": { "smithy.api#pattern": "(^$)|(^.*\\{language\\}.*$)" } }, "com.amazonaws.elastictranscoder#CaptionFormats": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#CaptionFormat" }, "traits": { "smithy.api#length": { "min": 0, "max": 4 } } }, "com.amazonaws.elastictranscoder#CaptionMergePolicy": { "type": "string", "traits": { "smithy.api#pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)" } }, "com.amazonaws.elastictranscoder#CaptionSource": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elastictranscoder#LongKey", "traits": { "smithy.api#documentation": "The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
" } }, "Language": { "target": "com.amazonaws.elastictranscoder#Key", "traits": { "smithy.api#documentation": "A string that specifies the language of the caption. If you specified multiple inputs with captions, \n the caption language must match in order to be included in the output. Specify this as one of:
\n2-character ISO 639-1 code
\n3-character ISO 639-2 code
\nFor more information on ISO language codes and language names, see the List of ISO 639-1 codes.
" } }, "TimeOffset": { "target": "com.amazonaws.elastictranscoder#TimeOffset", "traits": { "smithy.api#documentation": "For 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.
" } }, "Label": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The label of the caption shown in the player when choosing a language. We recommend that you \n put the caption language name here, in the language of the captions.
" } }, "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { "smithy.api#documentation": "The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you \n want Elastic Transcoder to apply to your caption sources.
" } } }, "traits": { "smithy.api#documentation": "A source file for the input sidecar captions used during the transcoding process.
" } }, "com.amazonaws.elastictranscoder#CaptionSources": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#CaptionSource" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.elastictranscoder#Captions": { "type": "structure", "members": { "MergePolicy": { "target": "com.amazonaws.elastictranscoder#CaptionMergePolicy", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "A policy that determines how Elastic Transcoder handles the existence of multiple captions.
\n\n MergeOverride: 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.
\n\n 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 CaptionSources is empty,\n Elastic Transcoder omits all sidecar captions from the output files.
\n Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources.
\n MergePolicy cannot be null.
Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
" } } }, "traits": { "smithy.api#documentation": "The captions to be created, if any.
" } }, "com.amazonaws.elastictranscoder#Clip": { "type": "structure", "members": { "TimeSpan": { "target": "com.amazonaws.elastictranscoder#TimeSpan", "traits": { "smithy.api#documentation": "Settings that determine when a clip begins and how long it lasts.
" } } }, "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
" } }, "com.amazonaws.elastictranscoder#CodecOption": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.elastictranscoder#CodecOptions": { "type": "map", "key": { "target": "com.amazonaws.elastictranscoder#CodecOption" }, "value": { "target": "com.amazonaws.elastictranscoder#CodecOption" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 } } }, "com.amazonaws.elastictranscoder#Composition": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#Clip" }, "traits": { "smithy.api#deprecated": {} } }, "com.amazonaws.elastictranscoder#CreateJob": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#CreateJobRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#CreateJobResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#LimitExceededException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified \n 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 Elastic Transcoder API to \n list the jobs (as opposed to the AWS Console).
", "smithy.api#http": { "method": "POST", "uri": "/2012-09-25/jobs", "code": 201 } } }, "com.amazonaws.elastictranscoder#CreateJobOutput": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elastictranscoder#Key", "traits": { "smithy.api#documentation": " 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 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 include \n in the file name for each thumbnail. You can specify the following values in any sequence:
\n\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.
If you specify a literal value and/or {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 \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 encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
" } }, "Rotate": { "target": "com.amazonaws.elastictranscoder#Rotate", "traits": { "smithy.api#documentation": " 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.
(Outputs in Fragmented MP4 or MPEG-TS format only.
\nIf you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or\n ts (MPEG-TS), SegmentDuration is the target maximum duration of\n each segment in seconds. For HLSv3 format playlists,\n each media segment is stored in a separate .ts file. For HLSv4 and Smooth\n playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of\n the SegmentDuration, though individual segments might be shorter or longer.
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 HLS output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in the OutputKeys of\n the associated playlist.
Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. \n You can specify up to four watermarks for each output. Settings for each watermark must be defined \n in the preset for the current output.
" } }, "AlbumArt": { "target": "com.amazonaws.elastictranscoder#JobAlbumArt", "traits": { "smithy.api#documentation": "Information about the album art that you want Elastic Transcoder to add to the file during transcoding. \n You can specify up to twenty album artworks for each output. Settings for each artwork must be \n defined in the job for the current output.
" } }, "Composition": { "target": "com.amazonaws.elastictranscoder#Composition", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "You can create an output file that contains an excerpt from the input file. This excerpt, called a \n clip, can come from the beginning, middle, or end of the file. The Composition object contains settings \n for the clips that make up an output file. For the current release, you can only specify settings for a \n single clip per output file. The Composition object cannot be null.
" } }, "Captions": { "target": "com.amazonaws.elastictranscoder#Captions", "traits": { "smithy.api#documentation": "You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All \n captions must be in UTF-8. Elastic Transcoder supports two types of captions:
\n\n Embedded: 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\n
Valid outputs include: mov-text\n
Elastic Transcoder supports a maximum of one embedded format per output.
\n\n Sidecar: 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\n
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 Wikipedia pages.
" } }, "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { "smithy.api#documentation": "You can specify encryption settings for any output files that you want to use for a \n transcoding job. This includes the output file and any watermarks, thumbnails, album art, \n or captions that you want to use. You must specify encryption settings for each file \n individually.
" } } }, "traits": { "smithy.api#documentation": "The CreateJobOutput structure.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. If the name includes a / character, \n the section of the name before the last / must be identical \n for all Name objects. If you create more than one\n master playlist, the values of all Name objects must be\n unique.
\n Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8\n for HLSv3 and HLSv4 playlists, and .ism and .ismc for \n Smooth playlists).\n If you include a file extension in Name, the file name will have\n two extensions.
The format of the output playlist. Valid formats include HLSv3, \n HLSv4, and Smooth.
For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object.
If your output is not HLS or does not have a segment duration set,\n the name of the output file is a concatenation of OutputKeyPrefix\n and Outputs:Key:
OutputKeyPrefixOutputs:Key\n
If your output is HLSv3 and has a segment duration set, or is not included in a\n playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a\n series of .ts files that include a five-digit\n sequential counter beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is included in an\n HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension\n of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with\n an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a \n file extension in Output Key, the file name will have two extensions.
\n\nIf you include more than one output in a playlist,\n any segment duration settings, clip settings, or caption settings must be the\n same for all outputs in the playlist. For Smooth playlists, the Audio:Profile,\n Video:Profile, and Video:FrameRate to\n Video:KeyframesMaxDist ratio must be the same for all outputs.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output \n files associated with this playlist.
" } }, "PlayReadyDrm": { "target": "com.amazonaws.elastictranscoder#PlayReadyDrm", "traits": { "smithy.api#documentation": "The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" } } }, "traits": { "smithy.api#documentation": "Information about the master playlist.
" } }, "com.amazonaws.elastictranscoder#CreateJobPlaylists": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#CreateJobPlaylist" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 } } }, "com.amazonaws.elastictranscoder#CreateJobRequest": { "type": "structure", "members": { "PipelineId": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "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.
A section of the request body that provides information about the file that is being\n transcoded.
" } }, "Inputs": { "target": "com.amazonaws.elastictranscoder#JobInputs", "traits": { "smithy.api#documentation": "A section of the request body that provides information about the files that are being \n transcoded.
" } }, "Output": { "target": "com.amazonaws.elastictranscoder#CreateJobOutput", "traits": { "smithy.api#documentation": " A section of the request body that provides information about the transcoded (target)\n file. We strongly recommend that you use the Outputs syntax instead of the\n Output syntax.
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 that this \n job creates, including output files, thumbnails, and playlists.
" } }, "Playlists": { "target": "com.amazonaws.elastictranscoder#CreateJobPlaylists", "traits": { "smithy.api#documentation": "If you specify a preset in PresetId for which the value of\n Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains \n information about the master playlists that you want Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
" } }, "UserMetadata": { "target": "com.amazonaws.elastictranscoder#UserMetadata", "traits": { "smithy.api#documentation": "User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in \n key/value pairs, and you can add up to 10 key/value pairs per job. \n Elastic Transcoder does not guarantee that key/value pairs are returned in the same \n order in which you specify them.
The CreateJobRequest structure.
A section of the response body that provides information about the job that is created.
" } } }, "traits": { "smithy.api#documentation": "The CreateJobResponse structure.
" } }, "com.amazonaws.elastictranscoder#CreatePipeline": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#CreatePipelineRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#CreatePipelineResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#LimitExceededException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The CreatePipeline operation creates a pipeline with settings that you specify.
", "smithy.api#http": { "method": "POST", "uri": "/2012-09-25/pipelines", "code": 201 } } }, "com.amazonaws.elastictranscoder#CreatePipelineRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The 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.
", "smithy.api#required": {} } }, "InputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The Amazon S3 bucket in which you saved the media files that you want to transcode.
", "smithy.api#required": {} } }, "OutputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use \n\t\t this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
\nSpecify this value when all of the following are true:
\n\t\tYou want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.
\nYou do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.
\nYou do not want to specify the permissions that Elastic Transcoder grants to the \n\t\t\t\t\n files.
\n\t\t\t\tWhen Elastic Transcoder saves files in\n OutputBucket, it grants full control over the files only to\n the AWS account that owns the role that is specified by\n Role.
You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.
\nIf 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 pipeline.
", "smithy.api#required": {} } }, "AwsKmsKeyArn": { "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { "smithy.api#documentation": "The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
\nIf you use either s3 or s3-aws-kms as your \n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nTo receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
\n\n Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to\n notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that\n Amazon SNS returned when you created the topic. For more information, see Create a\n Topic in the Amazon Simple Notification Service Developer Guide.
\n\n Complete: The topic ARN for the Amazon SNS topic that you want to notify when\n Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS\n returned when you created the topic.
\n\n Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition while processing a job in this pipeline. This is the\n ARN that Amazon SNS returned when you created the topic.
\n\n Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition while processing a job in this pipeline. This is the\n ARN that Amazon SNS returned when you created the topic.
\nThe 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.
\n\n Permissions (Optional): The Permissions object specifies which users you want\n to have access to transcoded files and the type of access you want them to have. You\n can grant permissions to a maximum of 30 users and/or predefined Amazon S3\n groups.
\n\n Grantee Type: Specify the type of value that appears in the\n Grantee object:
\n Canonical: The value in the 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.
A canonical user ID is not the same as an\n AWS account number.
\n\n Email: The value in the Grantee object is the registered\n email address of an AWS account.
\n Group: The value in the Grantee object is one of the\n following predefined Amazon S3 groups: AllUsers,\n AuthenticatedUsers, or LogDelivery.
\n Grantee: The AWS user or group that you want to have access to transcoded\n files and playlists. To identify the user or group, you can specify the canonical\n user ID for an AWS account, an origin access identity for a CloudFront distribution,\n the registered email address of an AWS account, or a predefined Amazon S3 group
\n\n Access: The permission that you want to give to the AWS user that you\n specified in Grantee. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include:
\n READ: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
\n StorageClass: The Amazon S3 storage class, 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 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files.
\n\n Permissions (Optional): The 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.
\n GranteeType: Specify the type of value that appears in the Grantee object:
\n\n Canonical: The value in the Grantee object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution.
A canonical user ID is not the\n same as an AWS account number.
\n\n Email: The value in the Grantee object is the registered\n email address of an AWS account.
\n Group: The value in the Grantee object is one of the\n following predefined Amazon S3 groups: AllUsers,\n AuthenticatedUsers, or LogDelivery.
\n Grantee: The AWS user or group that you want to have access to thumbnail\n files. To identify the user or group, you can specify the canonical user ID for an\n AWS account, an origin access identity for a CloudFront distribution, the registered\n email address of an AWS account, or a predefined Amazon S3 group.
\n\n Access: The permission that you want to give to the AWS user that you\n specified in Grantee. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include:
\n READ: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
\n 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 CreatePipelineRequest structure.
A section of the response body that provides information about the pipeline that is created.
" } }, "Warnings": { "target": "com.amazonaws.elastictranscoder#Warnings", "traits": { "smithy.api#documentation": "Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as \n the pipeline.
\nUsing resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and \n AWS KMS key, reduces processing time and prevents cross-regional charges.
" } } }, "traits": { "smithy.api#documentation": "When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.
" } }, "com.amazonaws.elastictranscoder#CreatePreset": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#CreatePresetRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#CreatePresetResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#LimitExceededException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The CreatePreset operation creates a preset with settings that you specify.
\nElastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements\n and to determine whether they comply with H.264 standards. If your settings are not\n valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) 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.
", "smithy.api#http": { "method": "POST", "uri": "/2012-09-25/presets", "code": 201 } } }, "com.amazonaws.elastictranscoder#CreatePresetRequest": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.elastictranscoder#Description", "traits": { "smithy.api#documentation": "A description of the preset.
" } }, "Container": { "target": "com.amazonaws.elastictranscoder#PresetContainer", "traits": { "smithy.api#documentation": "The container type for the output file. Valid values include flac,\n flv, fmp4, \n gif, mp3, \n mp4, mpg, mxf, oga, \n ogg, ts, and webm.
A section of the request body that specifies the video parameters.
" } }, "Audio": { "target": "com.amazonaws.elastictranscoder#AudioParameters", "traits": { "smithy.api#documentation": "A section of the request body that specifies the audio parameters.
" } }, "Thumbnails": { "target": "com.amazonaws.elastictranscoder#Thumbnails", "traits": { "smithy.api#documentation": "A section of the request body that specifies the thumbnail parameters, if any.
" } } }, "traits": { "smithy.api#documentation": "The CreatePresetRequest structure.
A section of the response body that provides information about the preset that is created.
" } }, "Warning": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "If 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 \n acceptable output.
" } } }, "traits": { "smithy.api#documentation": "The CreatePresetResponse structure.
The 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 pipeline that you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The DeletePipelineRequest structure.
The DeletePipelineResponse structure.
The 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 identifier of the preset for which you want to get detailed information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The DeletePresetRequest structure.
The DeletePresetResponse structure.
The detected width of the input file, in pixels.
" } }, "Height": { "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { "smithy.api#documentation": "The detected height of the input file, in pixels.
" } }, "FrameRate": { "target": "com.amazonaws.elastictranscoder#FloatString", "traits": { "smithy.api#documentation": "The detected frame rate of the input file, in frames per second.
" } }, "FileSize": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "The detected file size of the input file, in bytes.
" } }, "DurationMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "The detected duration of the input file, in milliseconds.
" } } }, "traits": { "smithy.api#documentation": "The detected properties of the input file. Elastic Transcoder identifies these values from the input file.
" } }, "com.amazonaws.elastictranscoder#Digits": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{1,5}$" } }, "com.amazonaws.elastictranscoder#DigitsOrAuto": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^\\d{2,4}$)" } }, "com.amazonaws.elastictranscoder#Encryption": { "type": "structure", "members": { "Mode": { "target": "com.amazonaws.elastictranscoder#EncryptionMode", "traits": { "smithy.api#documentation": "The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting \n your input files or encrypting your output files. Elastic Transcoder supports the following options:
\n\n s3: Amazon S3 creates and manages the\n keys used for encrypting your files.
\n\n s3-aws-kms: Amazon S3 calls the Amazon Key Management \n Service, which\n creates and manages the keys that are used for encrypting your files. If you specify\n s3-aws-kms and you don't want to use the default key,\n you must add the AWS-KMS key that you want to use to your pipeline.
\n aes-cbc-pkcs7: A padded cipher-block\n mode of operation originally used for HLS files.
\n\n aes-ctr: AES Counter Mode.
\n\n aes-gcm: AES Galois Counter Mode,\n a mode of operation that is an authenticated encryption format, meaning that a file, key,\n or initialization vector that has been tampered with fails the decryption\n process.
\nFor all three AES options, you must provide the following settings, which must be base64-encoded:
\n\n Key\n
\n\n Key MD5\n
\n\n Initialization Vector\n
\nFor the AES modes, your private encryption keys and your unencrypted data are never \n stored by AWS; therefore, it is important that you safely manage your encryption keys. \n If you lose them, you won't be able to unencrypt your data.
\nThe data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that \n was used to encrypt your input file. The key must be base64-encoded and it must be one of the \n following bit lengths before being base64-encoded:
\n\n 128, 192, or 256.
The key must also be encrypted by using the Amazon Key Management Service.
" } }, "KeyMd5": { "target": "com.amazonaws.elastictranscoder#Base64EncodedString", "traits": { "smithy.api#documentation": "The MD5 digest of the key that you used to encrypt your input file, or that you want \n Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a \n checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, \n and it must be exactly 16 bytes long before being base64-encoded.
" } }, "InitializationVector": { "target": "com.amazonaws.elastictranscoder#ZeroTo255String", "traits": { "smithy.api#documentation": "The series of random bits created by a random bit generator, unique for every encryption \n operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt \n your output files. The initialization vector must be base64-encoded, and it must be exactly \n 16 bytes long before being base64-encoded.
" } } }, "traits": { "smithy.api#documentation": "The encryption settings, if any, that are used for decrypting your input files or \n encrypting your output files. If your input file is encrypted, you must specify the mode \n that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want \n Elastic Transcoder to use to encrypt your output files.
" } }, "com.amazonaws.elastictranscoder#EncryptionMode": { "type": "string", "traits": { "smithy.api#pattern": "(^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)" } }, "com.amazonaws.elastictranscoder#EtsCustomerService": { "type": "service", "version": "2012-09-25", "operations": [ { "target": "com.amazonaws.elastictranscoder#CancelJob" }, { "target": "com.amazonaws.elastictranscoder#CreateJob" }, { "target": "com.amazonaws.elastictranscoder#CreatePipeline" }, { "target": "com.amazonaws.elastictranscoder#CreatePreset" }, { "target": "com.amazonaws.elastictranscoder#DeletePipeline" }, { "target": "com.amazonaws.elastictranscoder#DeletePreset" }, { "target": "com.amazonaws.elastictranscoder#ListJobsByPipeline" }, { "target": "com.amazonaws.elastictranscoder#ListJobsByStatus" }, { "target": "com.amazonaws.elastictranscoder#ListPipelines" }, { "target": "com.amazonaws.elastictranscoder#ListPresets" }, { "target": "com.amazonaws.elastictranscoder#ReadJob" }, { "target": "com.amazonaws.elastictranscoder#ReadPipeline" }, { "target": "com.amazonaws.elastictranscoder#ReadPreset" }, { "target": "com.amazonaws.elastictranscoder#TestRole" }, { "target": "com.amazonaws.elastictranscoder#UpdatePipeline" }, { "target": "com.amazonaws.elastictranscoder#UpdatePipelineNotifications" }, { "target": "com.amazonaws.elastictranscoder#UpdatePipelineStatus" } ], "traits": { "aws.api#service": { "sdkId": "Elastic Transcoder", "arnNamespace": "elastictranscoder", "cloudFormationName": "ElasticTranscoder", "cloudTrailEventSource": "elastictranscoder.amazonaws.com", "endpointPrefix": "elastictranscoder" }, "aws.auth#sigv4": { "name": "elastictranscoder" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "The AWS Elastic Transcoder Service.
", "smithy.api#title": "Amazon Elastic Transcoder", "smithy.api#xmlNamespace": { "uri": "http://elastictranscoder.amazonaws.com/doc/2012-09-25/" } } }, "com.amazonaws.elastictranscoder#ExceptionMessage": { "type": "string" }, "com.amazonaws.elastictranscoder#ExceptionMessages": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#String" } }, "com.amazonaws.elastictranscoder#Filename": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.elastictranscoder#FixedGOP": { "type": "string", "traits": { "smithy.api#pattern": "(^true$)|(^false$)" } }, "com.amazonaws.elastictranscoder#FloatString": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{1,5}(\\.\\d{0,5})?$" } }, "com.amazonaws.elastictranscoder#FrameRate": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" } }, "com.amazonaws.elastictranscoder#Grantee": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.elastictranscoder#GranteeType": { "type": "string", "traits": { "smithy.api#pattern": "(^Canonical$)|(^Email$)|(^Group$)" } }, "com.amazonaws.elastictranscoder#HlsContentProtection": { "type": "structure", "members": { "Method": { "target": "com.amazonaws.elastictranscoder#HlsContentProtectionMethod", "traits": { "smithy.api#documentation": "The content protection method for your output. The only valid value is:\naes-128.
This value is written into the method attribute of the EXT-X-KEY metadata tag in the output\nplaylist.
If you want Elastic Transcoder to generate a key for you, leave this field blank.
\nIf you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be \n base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
\n\n 128, 192, or 256.
If Elastic Transcoder is generating your key for you, you must leave this field blank.
\nThe MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want \n Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be \n base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
" } }, "InitializationVector": { "target": "com.amazonaws.elastictranscoder#ZeroTo255String", "traits": { "smithy.api#documentation": "If Elastic Transcoder is generating your key for you, you must leave this field blank.
\nThe series of random bits created by a random bit generator, unique for every encryption operation, \n that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, \n and it must be exactly 16 bytes before being base64-encoded.
" } }, "LicenseAcquisitionUrl": { "target": "com.amazonaws.elastictranscoder#ZeroTo512String", "traits": { "smithy.api#documentation": "The location of the license key required to decrypt your HLS playlist. The URL must be an absolute \n path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
" } }, "KeyStoragePolicy": { "target": "com.amazonaws.elastictranscoder#KeyStoragePolicy", "traits": { "smithy.api#documentation": "Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If \nyou choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder \nwrites your data key into the same bucket as the associated playlist.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
" } }, "com.amazonaws.elastictranscoder#HlsContentProtectionMethod": { "type": "string", "traits": { "smithy.api#pattern": "(^aes-128$)" } }, "com.amazonaws.elastictranscoder#HorizontalAlign": { "type": "string", "traits": { "smithy.api#pattern": "(^Left$)|(^Right$)|(^Center$)" } }, "com.amazonaws.elastictranscoder#Id": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{13}-\\w{6}$" } }, "com.amazonaws.elastictranscoder#IncompatibleVersionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elastictranscoder#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elastictranscoder#InputCaptions": { "type": "structure", "members": { "MergePolicy": { "target": "com.amazonaws.elastictranscoder#CaptionMergePolicy", "traits": { "smithy.api#documentation": "A policy that determines how Elastic Transcoder handles the existence of multiple captions.
\n\n MergeOverride: 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.
\n\n 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 CaptionSources is empty,\n Elastic Transcoder omits all sidecar captions from the output files.
\n Override: Elastic Transcoder transcodes only the\n sidecar captions that you specify in CaptionSources.
\n MergePolicy cannot be null.
Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave CaptionSources blank.
The captions to be created, if any.
" } }, "com.amazonaws.elastictranscoder#Interlaced": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^true$)|(^false$)" } }, "com.amazonaws.elastictranscoder#InternalServiceException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elastictranscoder#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
", "smithy.api#error": "server" } }, "com.amazonaws.elastictranscoder#Job": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
" } }, "Arn": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the job.
" } }, "PipelineId": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": " 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.
A section of the request or response body that provides information about the file that is being transcoded.
" } }, "Inputs": { "target": "com.amazonaws.elastictranscoder#JobInputs", "traits": { "smithy.api#documentation": "Information about the files that you're transcoding. If you specified multiple files for this \n job, Elastic Transcoder stitches the files together to make one output.
" } }, "Output": { "target": "com.amazonaws.elastictranscoder#JobOutput", "traits": { "smithy.api#documentation": "If you specified one output for a job, information about that output. If you \n\t\tspecified multiple outputs for a job, the Output object lists information about the first \n\t\toutput. This duplicates the information that is listed for the first output in the Outputs object.
\nOutputs recommended instead.
\nA section of the request or response\n body that provides information about the transcoded (target) file.
" } }, "Outputs": { "target": "com.amazonaws.elastictranscoder#JobOutputs", "traits": { "smithy.api#documentation": "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 each output \n in the order in which you specify them in the job.
" } }, "OutputKeyPrefix": { "target": "com.amazonaws.elastictranscoder#Key", "traits": { "smithy.api#documentation": "The 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.
Outputs in Fragmented MP4 or MPEG-TS format only.
\nIf you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.
The maximum number of master playlists in a job is 30.
" } }, "Status": { "target": "com.amazonaws.elastictranscoder#JobStatus", "traits": { "smithy.api#documentation": " The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in\n key/value pairs, and you can add up to 10 key/value pairs per job.\n Elastic Transcoder does not guarantee that key/value pairs are returned in the same\n order in which you specify them.
Metadata keys and values must use characters from the following list:
\n 0-9\n
\n A-Z and a-z\n
\n Space\n
The following symbols: _.:/=+-%@\n
Details about the timing of a job.
" } } }, "traits": { "smithy.api#documentation": "A section of the response body that provides information about the job that is created.
" } }, "com.amazonaws.elastictranscoder#JobAlbumArt": { "type": "structure", "members": { "MergePolicy": { "target": "com.amazonaws.elastictranscoder#MergePolicy", "traits": { "smithy.api#documentation": "A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.
\n \n\n Replace: The specified album art replaces any existing album art.
\n Prepend: The specified album art is placed in front of any existing \n album art.
\n Append: The specified album art is placed after any existing album art.
\n Fallback: If the original input file contains artwork, Elastic Transcoder uses that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the \n specified album art file.
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\n
The .jpg or .png file associated with an audio file.
" } }, "com.amazonaws.elastictranscoder#JobContainer": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)" } }, "com.amazonaws.elastictranscoder#JobInput": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.elastictranscoder#LongKey", "traits": { "smithy.api#documentation": " 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:
\n true, false\n
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
The encryption settings, if any, that are used for decrypting your input files. If \n your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.
" } }, "TimeSpan": { "target": "com.amazonaws.elastictranscoder#TimeSpan", "traits": { "smithy.api#documentation": "Settings for clipping an input. Each input can have different clip settings.
" } }, "InputCaptions": { "target": "com.amazonaws.elastictranscoder#InputCaptions", "traits": { "smithy.api#documentation": "You 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:
\n\n Embedded: 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\n
Valid outputs include: mov-text\n
Elastic Transcoder supports a maximum of one embedded format per output.
\n\n Sidecar: 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\n
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 Wikipedia pages.
" } }, "DetectedProperties": { "target": "com.amazonaws.elastictranscoder#DetectedProperties", "traits": { "smithy.api#documentation": "The detected properties of the input file.
" } } }, "traits": { "smithy.api#documentation": "Information about the file that you're transcoding.
" } }, "com.amazonaws.elastictranscoder#JobInputs": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#JobInput" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.elastictranscoder#JobOutput": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "A 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.
" } }, "Key": { "target": "com.amazonaws.elastictranscoder#Key", "traits": { "smithy.api#documentation": " 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 \n Elastic Transcoder 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 sequence:
\n\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.
If you specify a literal value and/or {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 \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 encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
" } }, "Rotate": { "target": "com.amazonaws.elastictranscoder#Rotate", "traits": { "smithy.api#documentation": "The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative \n to the input. Enter one of the following values:
\n\n auto, 0, 90, 180,\n 270\n
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.
(Outputs in Fragmented MP4 or MPEG-TS format only.
\nIf you specify a preset in\n PresetId for which the value of Container is fmp4 (Fragmented MP4) or \n ts (MPEG-TS), SegmentDuration is the target maximum duration of\n each segment in seconds. For HLSv3 format playlists,\n each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth\n playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of\n the SegmentDuration, though individual segments might be shorter or longer.
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 HLS output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in the OutputKeys of \n the associated playlist.
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:
\n Job:Status and Outputs:Status for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.
When Elastic Transcoder starts to process the first output,\n 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 remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.
\nWhen all of the outputs reach a terminal status, 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.
The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.
Information that further explains Status.
Duration of the output file, in seconds.
" } }, "Width": { "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { "smithy.api#documentation": "Specifies the width of the output file in pixels.
" } }, "Height": { "target": "com.amazonaws.elastictranscoder#NullableInteger", "traits": { "smithy.api#documentation": "Height of the output file, in pixels.
" } }, "FrameRate": { "target": "com.amazonaws.elastictranscoder#FloatString", "traits": { "smithy.api#documentation": "Frame rate of the output file, in frames per second.
" } }, "FileSize": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "File size of the output file, in bytes.
" } }, "DurationMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "Duration of the output file, in milliseconds.
" } }, "Watermarks": { "target": "com.amazonaws.elastictranscoder#JobWatermarks", "traits": { "smithy.api#documentation": "Information 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 \n in the job output—the first watermark in the list is added to the output video first, \n the second watermark in the list is added next, and so on. As a result, if the settings \n in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark \n that you add covers the first one, the third one covers the second, and the \n fourth one covers the third.
" } }, "AlbumArt": { "target": "com.amazonaws.elastictranscoder#JobAlbumArt", "traits": { "smithy.api#documentation": "The album art to be associated with the output file, if any.
" } }, "Composition": { "target": "com.amazonaws.elastictranscoder#Composition", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "You can create an output file that contains an excerpt from the input file. This excerpt, called \n a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings \n for the clips that make up an output file. For the current release, you can only specify settings for a \n single clip per output file. The Composition object cannot be null.
" } }, "Captions": { "target": "com.amazonaws.elastictranscoder#Captions", "traits": { "smithy.api#documentation": "You 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:
\n\n Embedded: 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\n
Valid outputs include: mov-text\n
Elastic Transcoder supports a maximum of one embedded format per output.
\n\n Sidecar: 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\n
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 Wikipedia pages.
" } }, "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { "smithy.api#documentation": "The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. \n If you choose to use encryption, you must specify a mode to use. If you choose not to \n use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
" } }, "AppliedColorSpaceConversion": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output\n file, the AppliedColorSpaceConversion parameter shows the conversion used. If no \n ColorSpaceConversionMode was defined in the preset, this parameter is not be \n included in the job response.
Outputs recommended instead.
\nIf you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n Output object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs\n object.
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. \n The settings are in the preset specified by Preset for the current output. In that preset, the value \n of Watermarks Id tells Elastic Transcoder which settings to use.
" } }, "InputKey": { "target": "com.amazonaws.elastictranscoder#WatermarkKey", "traits": { "smithy.api#documentation": " 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, \n include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.
" } }, "Encryption": { "target": "com.amazonaws.elastictranscoder#Encryption", "traits": { "smithy.api#documentation": "The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
" } } }, "traits": { "smithy.api#documentation": "Watermarks 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.
" } }, "com.amazonaws.elastictranscoder#JobWatermarks": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#JobWatermark" } }, "com.amazonaws.elastictranscoder#Jobs": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#Job" } }, "com.amazonaws.elastictranscoder#JpgOrPng": { "type": "string", "traits": { "smithy.api#pattern": "(^jpg$)|(^png$)" } }, "com.amazonaws.elastictranscoder#Key": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.elastictranscoder#KeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.elastictranscoder#KeyIdGuid": { "type": "string", "traits": { "smithy.api#pattern": "(^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)|(^[0-9A-Fa-f]{32}$)" } }, "com.amazonaws.elastictranscoder#KeyStoragePolicy": { "type": "string", "traits": { "smithy.api#pattern": "(^NoStore$)|(^WithVariantPlaylists$)" } }, "com.amazonaws.elastictranscoder#KeyframesMaxDist": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{1,6}$" } }, "com.amazonaws.elastictranscoder#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elastictranscoder#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Too many operations for a given AWS account. For example, the number of pipelines \n exceeds the maximum allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.elastictranscoder#ListJobsByPipeline": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#ListJobsByPipelineRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#ListJobsByPipelineResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The 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 response body contains \n one element for each job that satisfies the search criteria.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/jobsByPipeline/{PipelineId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", "items": "Jobs" } } }, "com.amazonaws.elastictranscoder#ListJobsByPipelineRequest": { "type": "structure", "members": { "PipelineId": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The ID of the pipeline for which you want to get job information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Ascending": { "target": "com.amazonaws.elastictranscoder#Ascending", "traits": { "smithy.api#documentation": " 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.
An 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.
The ListJobsByStatus operation gets a list of jobs that have a specified status. The response \n body contains one element for each job that satisfies the search criteria.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/jobsByStatus/{Status}", "code": 200 }, "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", "items": "Jobs" } } }, "com.amazonaws.elastictranscoder#ListJobsByStatusRequest": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.elastictranscoder#JobStatus", "traits": { "smithy.api#documentation": "To 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.
An 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
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/pipelines", "code": 200 }, "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", "items": "Pipelines" } } }, "com.amazonaws.elastictranscoder#ListPipelinesRequest": { "type": "structure", "members": { "Ascending": { "target": "com.amazonaws.elastictranscoder#Ascending", "traits": { "smithy.api#documentation": "To 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.
An 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.
" } }, "com.amazonaws.elastictranscoder#ListPresets": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#ListPresetsRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#ListPresetsResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that \n you've added in an AWS region.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/presets", "code": 200 }, "smithy.api#paginated": { "inputToken": "PageToken", "outputToken": "NextPageToken", "items": "Presets" } } }, "com.amazonaws.elastictranscoder#ListPresetsRequest": { "type": "structure", "members": { "Ascending": { "target": "com.amazonaws.elastictranscoder#Ascending", "traits": { "smithy.api#documentation": "To 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.
An 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.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
" } }, "Completed": { "target": "com.amazonaws.elastictranscoder#SnsTopic", "traits": { "smithy.api#documentation": "The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
" } }, "Warning": { "target": "com.amazonaws.elastictranscoder#SnsTopic", "traits": { "smithy.api#documentation": "The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
" } }, "Error": { "target": "com.amazonaws.elastictranscoder#SnsTopic", "traits": { "smithy.api#documentation": "The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
" } } }, "traits": { "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
\nTo receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
\nThe type of value that appears in the Grantee object:
\n\t\t\n Canonical: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution.
A\n canonical user ID is not the same as an AWS account number.
\n\n Email: The registered email address of an AWS account.
\n 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 origin \n access identity for a CloudFront distribution, the registered email address of an AWS account, \n or a predefined Amazon S3 group.
" } }, "Access": { "target": "com.amazonaws.elastictranscoder#AccessControls", "traits": { "smithy.api#documentation": "The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:
\n\t\t\t\n READ: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
The identifier for the pipeline. You use this value to identify the pipeline in \n which you want to perform a variety of operations, such as creating a job or a preset.
" } }, "Arn": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pipeline.
" } }, "Name": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The 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
" } }, "Status": { "target": "com.amazonaws.elastictranscoder#PipelineStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline:
\n\n Active: The pipeline is processing jobs.
\n Paused: The pipeline is not currently processing jobs.
The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics \n files, if any, that you want to use for watermarks.
" } }, "OutputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The 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 jobs for this pipeline.
" } }, "AwsKmsKeyArn": { "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { "smithy.api#documentation": "The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
\nIf you use either s3 or s3-aws-kms as your\n Encryption:Mode, you don't need to provide a key with\n your job because a default key, known as an AWS-KMS key, is created for you automatically.\n You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are\n using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nTo receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
\n\n Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.
\n\n Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.
\n\n Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.
\n\n Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.
\nInformation 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.
\n\n Permissions: A list of the users and/or predefined Amazon S3 groups you want\n to have access to transcoded files and playlists, and the type of access that you\n want them to have.
\n\t\t\t\tGranteeType: The type of value that appears in the Grantee\n object:
\n Canonical: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.
\n Email: The registered email address of an AWS\n account.
\n Group: One of the following predefined Amazon S3\n groups: AllUsers, AuthenticatedUsers, or\n LogDelivery.
\n Grantee: The AWS user or group that you want to have access to\n transcoded files and playlists.
\n Access: The permission that you want to give to the AWS user\n that is listed in Grantee. Valid values include:
\n READ: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
\n StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it\n stores in your Amazon S3 bucket.
\nInformation 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files.
\n 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.
GranteeType: The type of value that appears in the Grantee object:
\n\t\t\t\t\t\n Canonical: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.
A canonical user ID is not the same as an\n AWS account number.
\n\n Email: The registered email address of an AWS\n account.
\n Group: One of the following predefined Amazon S3\n groups: AllUsers, AuthenticatedUsers, or\n LogDelivery.
\n Grantee: The AWS user or group that you want to have access to\n thumbnail files.
Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include:
\n\t\t\t\t\t\t\n READ: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.
\n READ_ACP: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.
\n WRITE_ACP: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.
\n 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.
\n 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.
" } }, "com.amazonaws.elastictranscoder#PipelineOutputConfig": { "type": "structure", "members": { "Bucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "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:
\n\t\t\tYou want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.
\nYou do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.
\nYou do not want to specify the permissions that Elastic Transcoder grants to the files.
\nYou want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.
\nIf 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 and specify\n values for ContentConfig and ThumbnailConfig instead.
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.
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 PipelineOutputConfig structure.
The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" } }, "Key": { "target": "com.amazonaws.elastictranscoder#NonEmptyBase64EncodedString", "traits": { "smithy.api#documentation": "The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, \n and it must be one of the following bit lengths before being base64-encoded:
\n\n 128, 192, or 256.
The key must also be encrypted by using AWS KMS.
" } }, "KeyMd5": { "target": "com.amazonaws.elastictranscoder#NonEmptyBase64EncodedString", "traits": { "smithy.api#documentation": "The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum \n to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be \n exactly 16 bytes before being base64-encoded.
" } }, "KeyId": { "target": "com.amazonaws.elastictranscoder#KeyIdGuid", "traits": { "smithy.api#documentation": "The ID for your DRM key, so that your DRM license provider knows which key to provide.
\nThe key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting \n it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in \n big or little endian, check with your DRM provider.
" } }, "InitializationVector": { "target": "com.amazonaws.elastictranscoder#ZeroTo255String", "traits": { "smithy.api#documentation": "The series of random bits created by a random bit generator, unique for every encryption operation, \n that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it \n must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder \n generates one for you.
" } }, "LicenseAcquisitionUrl": { "target": "com.amazonaws.elastictranscoder#OneTo512String", "traits": { "smithy.api#documentation": "The location of the license key required to play DRM content. The URL must be an absolute path,\nand is referenced by the PlayReady header. The PlayReady header is referenced in the protection\nheader of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO\nmetadata tags for HLS playlist outputs. An example URL looks like this:\nhttps://www.example.com/exampleKey/\n
The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
\nPlayReady DRM encrypts your media files\nusing aes-ctr encryption.
If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.
The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. If the name includes a / character, the \n section of the name before the last / must be identical for all \n Name objects. If you create more than one\n master playlist, the values of all Name objects must be\n unique.
Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8\n for HLSv3 and HLSv4 playlists, and \n .ism and .ismc for Smooth playlists).\n If you include a file extension in Name, the file name will have\n two extensions.
The format of the output playlist. Valid formats include HLSv3, HLSv4,\nand Smooth.
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
\nIf your output is not HLS or does not have a segment duration set,\n the name of the output file is a concatenation of OutputKeyPrefix \n and Outputs:Key:
OutputKeyPrefixOutputs:Key\n
If your output is HLSv3 and has a segment duration set, or is not included in a \n playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a \n series of .ts files that include a five-digit\n sequential counter beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If your output is HLSv4, has a segment duration set, and is included in an\n HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension \n of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with \n an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file \n extension in Output Key, the file name will have two extensions.
\nIf you include more than one output in a playlist, \n any segment duration settings, clip settings, or caption settings must be the\n same for all outputs in the playlist. For Smooth playlists, the Audio:Profile,\n Video:Profile, and Video:FrameRate to\n Video:KeyframesMaxDist ratio must be the same for all outputs.
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" } }, "PlayReadyDrm": { "target": "com.amazonaws.elastictranscoder#PlayReadyDrm", "traits": { "smithy.api#documentation": "The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
" } }, "Status": { "target": "com.amazonaws.elastictranscoder#JobStatus", "traits": { "smithy.api#documentation": "The status of the job with which the playlist is associated.
" } }, "StatusDetail": { "target": "com.amazonaws.elastictranscoder#Description", "traits": { "smithy.api#documentation": "Information that further explains the status.
" } } }, "traits": { "smithy.api#documentation": " Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container\n is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists \n contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist per output format. The maximum number of master playlists in a job is 30.
Identifier for the new preset. You use this value to get settings for the preset or to delete it.
" } }, "Arn": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the preset.
" } }, "Name": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The name of the preset.
" } }, "Description": { "target": "com.amazonaws.elastictranscoder#Description", "traits": { "smithy.api#documentation": "A description of the preset.
" } }, "Container": { "target": "com.amazonaws.elastictranscoder#PresetContainer", "traits": { "smithy.api#documentation": "The container type for the output file. Valid values include flac, \n flv, fmp4, gif, mp3, \n mp4, mpg, mxf, oga, \n ogg, ts, and webm.
A section of the response body that provides information about the audio preset values.
" } }, "Video": { "target": "com.amazonaws.elastictranscoder#VideoParameters", "traits": { "smithy.api#documentation": "A section of the response body that provides information about the video preset values.
" } }, "Thumbnails": { "target": "com.amazonaws.elastictranscoder#Thumbnails", "traits": { "smithy.api#documentation": "A section of the response body that provides information about the thumbnail preset values, if any.
" } }, "Type": { "target": "com.amazonaws.elastictranscoder#PresetType", "traits": { "smithy.api#documentation": "Whether 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 \n from 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 formats \n that aren't included among the default presets. You specify which preset you want to use \n when you create a job.
" } }, "com.amazonaws.elastictranscoder#PresetContainer": { "type": "string", "traits": { "smithy.api#pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)|(^wav$)|(^mp2$)" } }, "com.amazonaws.elastictranscoder#PresetType": { "type": "string", "traits": { "smithy.api#pattern": "(^System$)|(^Custom$)" } }, "com.amazonaws.elastictranscoder#PresetWatermark": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#PresetWatermarkId", "traits": { "smithy.api#documentation": " A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long.
The maximum width of the watermark in one of the following formats:
\n\t\tnumber of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of MaxWidth.
integer percentage (%): The range of valid values is 0 to 100. Use the value of\n 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.
If\n you specify the value in pixels, it must be less than or equal to the value of\n MaxWidth.
The maximum height of the watermark in one of the following formats:
\n\t\tnumber of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of MaxHeight.
integer percentage (%): The range of valid values is 0 to 100. Use the value of\n 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.
If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.
A value that controls scaling of the watermark:
\n\t\t\n Fit: Elastic Transcoder scales the watermark so it matches the value that\n you specified in either MaxWidth or MaxHeight without\n exceeding the other value.
\n Stretch: Elastic Transcoder stretches the watermark to match the values\n that you specified for 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.
\n ShrinkToFit: Elastic Transcoder scales the watermark 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\n watermark up.
The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:
\n Left: The left edge of the watermark is aligned with the left border of\n the video.
\n\n Right: The right edge of the watermark is aligned with the right border\n of the video.
\n\n Center: The watermark is centered between the left and right\n borders.
\nThe amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:
\n\t\t\tnumber of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.
\ninteger percentage (%): The range of valid values is 0 to 100.
\nFor example, if you specify Left for 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:
\n Top: The top edge of the watermark is aligned with the top border of the\n video.
\n\n Bottom: The bottom edge of the watermark is aligned with the bottom\n border of the video.
\n\n Center: The watermark is centered between the top and bottom\n borders.
\n\n VerticalOffset\n
The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:
\n\t\t\tnumber of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxHeight.
integer percentage (%): The range of valid values is 0 to 100.
\nFor example, if you specify 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\n bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has \n added black bars, the watermark extends into the black bars. If the watermark extends \n 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:
\n Content: 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.
\n Frame: HorizontalOffset and VerticalOffset\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any. In addition, 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 \n overlay over videos that are transcoded using this preset. You can specify settings \n for up to four watermarks. Watermarks appear in the specified size and location, and \n with the 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 \n is not rectangular, use the .png format, which supports transparency.
\nWhen you create a job that uses this preset, you specify the .png or .jpg graphics \n that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics \n in the job than you specify watermark settings in the preset, which allows you to use \n the same preset for up to four watermarks that have different dimensions.
" } }, "com.amazonaws.elastictranscoder#PresetWatermarkId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 } } }, "com.amazonaws.elastictranscoder#PresetWatermarks": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#PresetWatermark" } }, "com.amazonaws.elastictranscoder#Presets": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#Preset" } }, "com.amazonaws.elastictranscoder#ReadJob": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#ReadJobRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#ReadJobResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The ReadJob operation returns detailed information about a job.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/jobs/{Id}", "code": 200 }, "smithy.waiters#waitable": { "JobComplete": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "Job.Status", "expected": "Complete", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "Job.Status", "expected": "Canceled", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "Job.Status", "expected": "Error", "comparator": "stringEquals" } } } ], "minDelay": 30 } } } }, "com.amazonaws.elastictranscoder#ReadJobRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier of the job for which you want to get detailed information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The ReadJobRequest structure.
A section of the response body that provides information about the job.
" } } }, "traits": { "smithy.api#documentation": "The ReadJobResponse structure.
The ReadPipeline operation gets detailed information about a pipeline.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/pipelines/{Id}", "code": 200 } } }, "com.amazonaws.elastictranscoder#ReadPipelineRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier of the pipeline to read.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The ReadPipelineRequest structure.
A section of the response body that provides information about the pipeline.
" } }, "Warnings": { "target": "com.amazonaws.elastictranscoder#Warnings", "traits": { "smithy.api#documentation": "Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region \n as the pipeline.
\nUsing resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, \n and AWS KMS key, reduces processing time and prevents cross-regional charges.
" } } }, "traits": { "smithy.api#documentation": "The ReadPipelineResponse structure.
The ReadPreset operation gets detailed information about a preset.
", "smithy.api#http": { "method": "GET", "uri": "/2012-09-25/presets/{Id}", "code": 200 } } }, "com.amazonaws.elastictranscoder#ReadPresetRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier of the preset for which you want to get detailed information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The ReadPresetRequest structure.
A section of the response body that provides information about the preset.
" } } }, "traits": { "smithy.api#documentation": "The ReadPresetResponse structure.
The resource you are attempting to change is in use. For example, you are attempting \n to delete a pipeline that is currently in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.elastictranscoder#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elastictranscoder#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The requested resource does not exist or is not available. For example, the pipeline \n to which you're trying to add a job doesn't exist or is still being created.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.elastictranscoder#Role": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:iam::\\w{12}:role/.+$" } }, "com.amazonaws.elastictranscoder#Rotate": { "type": "string", "traits": { "smithy.api#pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)" } }, "com.amazonaws.elastictranscoder#SizingPolicy": { "type": "string", "traits": { "smithy.api#pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)" } }, "com.amazonaws.elastictranscoder#SnsTopic": { "type": "string", "traits": { "smithy.api#pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)" } }, "com.amazonaws.elastictranscoder#SnsTopics": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#SnsTopic" }, "traits": { "smithy.api#length": { "min": 0, "max": 30 } } }, "com.amazonaws.elastictranscoder#StorageClass": { "type": "string", "traits": { "smithy.api#pattern": "(^ReducedRedundancy$)|(^Standard$)" } }, "com.amazonaws.elastictranscoder#String": { "type": "string" }, "com.amazonaws.elastictranscoder#Success": { "type": "string", "traits": { "smithy.api#pattern": "(^true$)|(^false$)" } }, "com.amazonaws.elastictranscoder#Target": { "type": "string", "traits": { "smithy.api#pattern": "(^Content$)|(^Frame$)" } }, "com.amazonaws.elastictranscoder#TestRole": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#TestRoleRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#TestRoleResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "The 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 IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
", "smithy.api#required": {} } }, "InputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
", "smithy.api#required": {} } }, "OutputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.
", "smithy.api#required": {} } }, "Topics": { "target": "com.amazonaws.elastictranscoder#SnsTopics", "traits": { "smithy.api#documentation": "The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": " 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.
The 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.
" } }, "Interval": { "target": "com.amazonaws.elastictranscoder#Digits", "traits": { "smithy.api#documentation": "The approximate number of seconds between thumbnails. Specify an integer value.
" } }, "Resolution": { "target": "com.amazonaws.elastictranscoder#ThumbnailResolution", "traits": { "smithy.api#documentation": "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 width and height of thumbnail files in pixels. Specify a value in the format\n \n width\n x \n height\n 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:
\n\n auto, 1:1, 4:3, 3:2,\n 16:9\n
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 1920 (Full HD) \n as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
" } }, "MaxHeight": { "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { "smithy.api#documentation": "The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 \n (Full HD) as the default value. If you specify a numeric value, enter an even integer \n between 32 and 3072.
" } }, "SizingPolicy": { "target": "com.amazonaws.elastictranscoder#SizingPolicy", "traits": { "smithy.api#documentation": "Specify one of the following values to control scaling of thumbnails:
\n \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.
\n 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.
\n 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.
\n 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.
\n 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.
\n 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.
Thumbnails for videos.
" } }, "com.amazonaws.elastictranscoder#Time": { "type": "string", "traits": { "smithy.api#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})?$)" } }, "com.amazonaws.elastictranscoder#TimeOffset": { "type": "string", "traits": { "smithy.api#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})?$)" } }, "com.amazonaws.elastictranscoder#TimeSpan": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.elastictranscoder#Time", "traits": { "smithy.api#documentation": "The place in the input file where you want a clip to start. The format can be either \n HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS \n (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of \n the input file.
" } }, "Duration": { "target": "com.amazonaws.elastictranscoder#Time", "traits": { "smithy.api#documentation": "The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; \n SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a \n value, 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 the \n file and returns a warning message.
" } } }, "traits": { "smithy.api#documentation": "Settings that determine when a clip begins and how long it lasts.
" } }, "com.amazonaws.elastictranscoder#Timing": { "type": "structure", "members": { "SubmitTimeMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "The time the job was submitted to Elastic Transcoder, in epoch milliseconds.
" } }, "StartTimeMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "The time the job began transcoding, in epoch milliseconds.
" } }, "FinishTimeMillis": { "target": "com.amazonaws.elastictranscoder#NullableLong", "traits": { "smithy.api#documentation": "The time the job finished transcoding, in epoch milliseconds.
" } } }, "traits": { "smithy.api#documentation": "Details about the timing of a job.
" } }, "com.amazonaws.elastictranscoder#UpdatePipeline": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#UpdatePipelineRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#UpdatePipelineResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceInUseException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": " Use the UpdatePipeline operation to update settings for a pipeline.
When you change pipeline settings, your changes take effect immediately.\n Jobs that you have already submitted and that Elastic Transcoder has not started to process are\n affected in addition to jobs that you submit after you change settings.
\nWith the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
\nWhen you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.
", "smithy.api#http": { "method": "POST", "uri": "/2012-09-25/pipelines/{Id}/notifications", "code": 200 } } }, "com.amazonaws.elastictranscoder#UpdatePipelineNotificationsRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier of the pipeline for which you want to change notification settings.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Notifications": { "target": "com.amazonaws.elastictranscoder#Notifications", "traits": { "smithy.api#documentation": "The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nTo receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
\n\n Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to\n notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This\n is the ARN that Amazon SNS returned when you created the topic.
\n\n Complete: The topic ARN for the Amazon SNS topic that you want to notify when\n Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when\n you created the topic.
\n\n Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition. This is the ARN that Amazon SNS returned when you\n created the topic.
\n\n Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition. This is the ARN that Amazon SNS returned when you\n created the topic.
\nThe UpdatePipelineNotificationsRequest structure.
A section of the response body that provides information about the pipeline associated \n with this notification.
" } } }, "traits": { "smithy.api#documentation": "The UpdatePipelineNotificationsResponse structure.
The ID of the pipeline that you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.elastictranscoder#Name", "traits": { "smithy.api#documentation": "The name of the pipeline. We recommend that the name be unique within the AWS account, but \n uniqueness is not enforced.
\nConstraints: Maximum 40 characters
" } }, "InputBucket": { "target": "com.amazonaws.elastictranscoder#BucketName", "traits": { "smithy.api#documentation": "The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics \n that you want to use as watermarks.
" } }, "Role": { "target": "com.amazonaws.elastictranscoder#Role", "traits": { "smithy.api#documentation": "The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for \n this pipeline.
" } }, "AwsKmsKeyArn": { "target": "com.amazonaws.elastictranscoder#KeyArn", "traits": { "smithy.api#documentation": "The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
\nIf you use either s3 or s3-aws-kms as your Encryption:Mode,\n you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is \n created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default \n AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr,\n or aes-gcm.
The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
\nTo receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
\n\n Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to\n notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This\n is the ARN that Amazon SNS returned when you created the topic.
\n\n Complete: The topic ARN for the Amazon SNS topic that you want to notify when\n Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when\n you created the topic.
\n\n Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition. This is the ARN that Amazon SNS returned when you\n created the topic.
\n\n Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition. This is the ARN that Amazon SNS returned when you\n created the topic.
\nThe 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.
\n\n Permissions (Optional): The Permissions object specifies which users you want\n to have access to transcoded files and the type of access you want them to have. You\n can grant permissions to a maximum of 30 users and/or predefined Amazon S3\n groups.
\n\n Grantee Type: Specify the type of value that appears in the\n Grantee object:
\n Canonical: The value in the 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.
A canonical user ID is not the same as an\n AWS account number.
\n\n Email: The value in the Grantee object is the registered\n email address of an AWS account.
\n Group: The value in the Grantee object is one of the\n following predefined Amazon S3 groups: AllUsers,\n AuthenticatedUsers, or LogDelivery.
\n Grantee: The AWS user or group that you want to have access to transcoded\n files and playlists. To identify the user or group, you can specify the canonical\n user ID for an AWS account, an origin access identity for a CloudFront distribution,\n the registered email address of an AWS account, or a predefined Amazon S3 group
\n\n Access: The permission that you want to give to the AWS user that you\n specified in Grantee. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include:
\n READ: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
\n StorageClass: The Amazon S3 storage class, 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 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.
\n Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files.
\n\n Permissions (Optional): The 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.
\n GranteeType: Specify the type of value that appears in the Grantee object:
\n\n Canonical: The value in the Grantee object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution.
A canonical user ID is not the\n same as an AWS account number.
\n\n Email: The value in the Grantee object is the registered\n email address of an AWS account.
\n Group: The value in the Grantee object is one of the\n following predefined Amazon S3 groups: AllUsers,\n AuthenticatedUsers, or LogDelivery.
\n Grantee: The AWS user or group that you want to have access to thumbnail\n files. To identify the user or group, you can specify the canonical user ID for an\n AWS account, an origin access identity for a CloudFront distribution, the registered\n email address of an AWS account, or a predefined Amazon S3 group.
\n\n Access: The permission that you want to give to the AWS user that you\n specified in Grantee. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include:
\n READ: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.
\n READ_ACP: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n WRITE_ACP: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.
\n 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.
\n 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 UpdatePipelineRequest structure.
The pipeline updated by this UpdatePipelineResponse call.
Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the \n pipeline.
\nUsing resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and \n AWS KMS key, reduces processing time and prevents cross-regional charges.
" } } }, "traits": { "smithy.api#documentation": "When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.
" } }, "com.amazonaws.elastictranscoder#UpdatePipelineStatus": { "type": "operation", "input": { "target": "com.amazonaws.elastictranscoder#UpdatePipelineStatusRequest" }, "output": { "target": "com.amazonaws.elastictranscoder#UpdatePipelineStatusResponse" }, "errors": [ { "target": "com.amazonaws.elastictranscoder#AccessDeniedException" }, { "target": "com.amazonaws.elastictranscoder#IncompatibleVersionException" }, { "target": "com.amazonaws.elastictranscoder#InternalServiceException" }, { "target": "com.amazonaws.elastictranscoder#ResourceInUseException" }, { "target": "com.amazonaws.elastictranscoder#ResourceNotFoundException" }, { "target": "com.amazonaws.elastictranscoder#ValidationException" } ], "traits": { "smithy.api#documentation": "The 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.
", "smithy.api#http": { "method": "POST", "uri": "/2012-09-25/pipelines/{Id}/status", "code": 200 } } }, "com.amazonaws.elastictranscoder#UpdatePipelineStatusRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.elastictranscoder#Id", "traits": { "smithy.api#documentation": "The identifier of the pipeline to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.elastictranscoder#PipelineStatus", "traits": { "smithy.api#documentation": "The desired status of the pipeline:
\n\n Active: The pipeline is processing jobs.
\n Paused: The pipeline is not currently processing jobs.
The UpdatePipelineStatusRequest structure.
A section of the response body that provides information about the pipeline.
" } } }, "traits": { "smithy.api#documentation": "When you update status for a pipeline,\n Elastic Transcoder returns the values that you specified in the request.
" } }, "com.amazonaws.elastictranscoder#UserMetadata": { "type": "map", "key": { "target": "com.amazonaws.elastictranscoder#String" }, "value": { "target": "com.amazonaws.elastictranscoder#String" } }, "com.amazonaws.elastictranscoder#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.elastictranscoder#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One or more required parameter values were not provided in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.elastictranscoder#VerticalAlign": { "type": "string", "traits": { "smithy.api#pattern": "(^Top$)|(^Bottom$)|(^Center$)" } }, "com.amazonaws.elastictranscoder#VideoBitRate": { "type": "string", "traits": { "smithy.api#pattern": "(^\\d{2,5}$)|(^auto$)" } }, "com.amazonaws.elastictranscoder#VideoCodec": { "type": "string", "traits": { "smithy.api#pattern": "(^H\\.264$)|(^vp8$)|(^vp9$)|(^mpeg2$)|(^gif$)" } }, "com.amazonaws.elastictranscoder#VideoParameters": { "type": "structure", "members": { "Codec": { "target": "com.amazonaws.elastictranscoder#VideoCodec", "traits": { "smithy.api#documentation": "The video codec for the output file. Valid values include gif, \n H.264, mpeg2, vp8, and vp9. \n You can only specify vp8 and vp9 when the container type is\n webm, gif when the container type is gif, \n and mpeg2 when the container type is mpg.
\n Profile (H.264/VP8/VP9 Only)\n
\nThe H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
\n\n baseline: The profile most commonly used for videoconferencing and for\n mobile applications.
\n main: The profile used for standard-definition digital TV\n broadcasts.
\n 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 levels:
\n\n 1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1\n
\n MaxReferenceFrames (H.264 Only)\n
\nApplicable only when the value of Video:Codec is H.264. The maximum number of \n previously decoded frames to use as a reference for decoding future frames. Valid \n values are integers 0 through 16, but we recommend that you not use a value greater \n than the 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.)
1 - 396
\n1b - 396
\n1.1 - 900
\n1.2 - 2376
\n1.3 - 2376
\n2 - 2376
\n2.1 - 4752
\n2.2 - 8100
\n3 - 8100
\n3.1 - 18000
\n3.2 - 20480
\n4 - 32768
\n4.1 - 32768
\n\n MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)\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 (Optional, H.264/MPEG2/VP8/VP9 only)\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 FMP4 or 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.
\n InterlacedMode (Optional, H.264/MPEG2 Only)\n
\nThe interlace mode for the output video.
\nInterlaced video is used to double the perceived frame rate for a video by interlacing \n two fields (one field on every other line, the other field on the other lines) so that the \n human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required \n for transmitting a video, but can result in blurred images and flickering.
\nValid values include Progressive (no interlacing, top to bottom),\n TopFirst (top field first), BottomFirst (bottom field\n first), and Auto.
If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If\n Auto is specified, Elastic Transcoder interlaces the output.
\n ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)\n
\nThe color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms\n used by the computer to store information about how to render color. Bt.601 is the\n standard for standard definition video, while Bt.709 is the standard for high definition\n video.
Valid values include None,\n Bt709toBt601, Bt601toBt709, and Auto.
If you chose Auto for ColorSpaceConversionMode and your output\n is interlaced, your frame rate is one of 23.97, 24,\n 25, 29.97, 50, or 60, your\n SegmentDuration is null, and you are using one of the resolution\n changes from the list below, Elastic Transcoder applies the following color space\n conversions:
\n Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709\n
\n Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709\n
\n HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601\n
\n HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601\n
Elastic Transcoder may change the behavior of the ColorspaceConversionMode\n Auto mode in the future. All outputs in a playlist must use the same\n ColorSpaceConversionMode.
If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the\n color space of a file. If you are unsure what ColorSpaceConversionMode was applied to \n your output file, you can check the AppliedColorSpaceConversion parameter included in \n your job response. If your job does not have an AppliedColorSpaceConversion in its \n response, no ColorSpaceConversionMode was applied.
\n ChromaSubsampling\n
\nThe sampling pattern for the chroma (color) channels of the output video.\n Valid values include yuv420p and yuv422p.
\n yuv420p samples the chroma information of every other horizontal and every other vertical\n line, yuv422p samples the color information of every horizontal line and every other \n vertical line.
\n LoopCount (Gif Only)\n
\nThe number of times you want the output gif to loop. Valid values include Infinite and \n integers between 0 and 100, inclusive.
Applicable only when the value of Video:Codec is one of H.264, MPEG2, \n or VP8.
The maximum number of frames between key frames. Key frames are fully encoded frames; \n the 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 is a \n key frame) and 100000, inclusive. A higher value results in higher compression but may also \n discernibly decrease video quality.
\nFor Smooth outputs, the FrameRate must have a constant ratio to the\n KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels\n while the file is being played.
For example, an input file can have a FrameRate of\n 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3.\n Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist\n of 90, 75, and 30, respectively.
Alternately, this can be achieved by setting FrameRate\n to auto and having the same values for MaxFrameRate and KeyframesMaxDist.
Applicable only when the value of Video:Codec is one of H.264, MPEG2,\n or VP8.
Whether to use a fixed value for FixedGOP. Valid values are\n true and false:
\n 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).
\n false: The distance between key frames can vary.
\n FixedGOP must be set to true for fmp4 containers.
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
\n1 - 64 : 80
\n1b - 128 : 160
\n1.1 - 192 : 240
\n1.2 - 384 : 480
\n1.3 - 768 : 960
\n2 - 2000 : 2500
\n3 - 10000 : 12500
\n3.1 - 14000 : 17500
\n3.2 - 20000 : 25000
\n4 - 20000 : 25000
\n4.1 - 50000 : 62500
\nThe frames per second for the video stream in the output file. Valid values include:
\n\n auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60\n
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:
\n\n width in pixels and height in pixels represent the Resolution of the\n output video.
\n\n maximum recommended decoding speed in Luma samples/second is less than or\n equal to the maximum value listed in the following table, based on the value that\n you specified for Level.
\nThe maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):
\n1 - 380160
\n1b - 380160
\n1.1 - 76800
\n1.2 - 1536000
\n1.3 - 3041280
\n2 - 3041280
\n2.1 - 5068800
\n2.2 - 5184000
\n3 - 10368000
\n3.1 - 27648000
\n3.2 - 55296000
\n4 - 62914560
\n4.1 - 62914560
\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:
\n auto: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.
\n \n width x height\n : The width and height of the output video\n in pixels.
Note the following about specifying the width and height:
\nThe width must be an even integer between 128 and 4096, inclusive.
\nThe height must be an even integer between 96 and 3072, inclusive.
\nIf you specify a resolution that is less than the resolution of the input file, Elastic Transcoder\n rescales the output file to the lower resolution.
\nIf you specify a resolution that is greater than the resolution of the input file,\n Elastic Transcoder rescales the output to the higher resolution.
\nWe recommend that you specify a resolution for which the product of width and height\n is less than or equal to the applicable value in the following list (List - Max\n width x height value):
\n1 - 25344
\n1b - 25344
\n1.1 - 101376
\n1.2 - 101376
\n1.3 - 101376
\n2 - 101376
\n2.1 - 202752
\n2.2 - 404720
\n3 - 404720
\n3.1 - 921600
\n3.2 - 1310720
\n4 - 2097152
\n4.1 - 2097152
\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:
\n\n auto, 1:1, 4:3, 3:2,\n 16:9\n
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 \n of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing \n (black bars on the top and bottom) to maintain the aspect ratio of the active region \n of the video.
" } }, "MaxWidth": { "target": "com.amazonaws.elastictranscoder#DigitsOrAuto", "traits": { "smithy.api#documentation": " 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.
" } }, "SizingPolicy": { "target": "com.amazonaws.elastictranscoder#SizingPolicy", "traits": { "smithy.api#documentation": "Specify one of the following values to control scaling of the output video:
\n \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.
\n 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.
\n 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.
\n 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.
\n 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.
\n 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.
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 four \n watermarks. Watermarks appear in the specified size and location, and with the specified \n 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 graphics in the job \n than you specify watermark settings in the preset, which allows you to use the same preset \n for up to four watermarks that have different dimensions.
" } } }, "traits": { "smithy.api#documentation": "The VideoParameters structure.
The code of the cross-regional warning.
" } }, "Message": { "target": "com.amazonaws.elastictranscoder#String", "traits": { "smithy.api#documentation": "The message explaining what resources are in a different region from the pipeline.
\nAWS KMS keys must be in the same region as the pipeline.
\nElastic Transcoder returns a warning if the resources used by your pipeline are not in the same region \n as the pipeline.
\nUsing resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, \n and AWS KMS key, reduces processing time and prevents cross-regional charges.
" } }, "com.amazonaws.elastictranscoder#Warnings": { "type": "list", "member": { "target": "com.amazonaws.elastictranscoder#Warning" } }, "com.amazonaws.elastictranscoder#WatermarkKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "(^.{1,1020}.jpg$)|(^.{1,1019}.jpeg$)|(^.{1,1020}.png$)" } }, "com.amazonaws.elastictranscoder#WatermarkSizingPolicy": { "type": "string", "traits": { "smithy.api#pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)" } }, "com.amazonaws.elastictranscoder#ZeroTo255String": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 } } }, "com.amazonaws.elastictranscoder#ZeroTo512String": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 } } } } }