7394 lines
1,018 KiB
JSON
7394 lines
1,018 KiB
JSON
{
|
|
"api_version": "2012-09-25",
|
|
"type": "rest-json",
|
|
"signature_version": "v4",
|
|
"service_full_name": "Amazon Elastic Transcoder",
|
|
"endpoint_prefix": "elastictranscoder",
|
|
"xmlnamespace": "http://elastictranscoder.amazonaws.com/doc/2012-09-25/",
|
|
"documentation": "\n <fullname>AWS Elastic Transcoder Service</fullname>\n <p>The AWS Elastic Transcoder Service.</p>\n ",
|
|
"operations": {
|
|
"CancelJob": {
|
|
"name": "CancelJob",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"uri": "/2012-09-25/jobs/{Id}",
|
|
"response_code": 202
|
|
},
|
|
"input": {
|
|
"shape_name": "CancelJobRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the job that you want to cancel. </p>\n <p>To get a list of the jobs (including their <code>jobId</code>) that have a status of\n <code>Submitted</code>, use the <a>ListJobsByStatus</a> API action.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": " \n <p>The <code>CancelJobRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CancelJobResponse",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The response body contains a JSON object. If the job is successfully canceled, the value\n of <code>Success</code> is <code>true</code>.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceInUseException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The CancelJob operation cancels an unfinished job.</p>\n <note>You can only cancel a job that has a status of <code>Submitted</code>. To prevent a\n pipeline from starting to process a job while you're getting the job identifier, use\n <a>UpdatePipelineStatus</a> to temporarily pause the pipeline.</note>\n <examples>\n <example>\n <request>DELETE /2012-09-25/jobs/3333333333333-abcde3 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]</request>\n <response>Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreateJob": {
|
|
"name": "CreateJob",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/jobs",
|
|
"response_code": 201
|
|
},
|
|
"input": {
|
|
"shape_name": "CreateJobRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The <code>Id</code> 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.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Input": {
|
|
"shape_name": "JobInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> 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 <code>InputBucket</code> object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p>\n <p>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify <code>auto</code>. If you want to specify the frame rate for\n the input file, enter one of the following values: </p>\n <p>\n <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>\n </p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n the frame rate.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <p>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify <code>auto</code>. If you want to specify the aspect\n ratio for the output file, enter one of the following values: </p>\n <p>\n <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code>\n </p>\n <p> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection\n of the aspect ratio. </p>\n "
|
|
},
|
|
"Interlaced": {
|
|
"shape_name": "Interlaced",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify <code>auto</code>. If you want to specify whether\n the input file is interlaced, enter one of the following values:</p>\n <p><code>true</code>, <code>false</code></p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n interlacing.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "JobContainer",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)",
|
|
"documentation": "\n <p>The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify <code>auto</code>. If you want to specify the\n container type for the input file, enter one of the following values: </p>\n <p>\n <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, \n <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, \n <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, \n <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, \n <code>vob</code>, <code>wav</code>, <code>webm</code>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the request body that provides information about the file that is being\n transcoded.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Output": {
|
|
"shape_name": "CreateJobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> 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. </p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: <code>auto</code>, <code>0</code>,\n <code>90</code>, <code>180</code>, <code>270</code>. The value <code>auto</code>\n generally works only if the file that you're transcoding contains rotation metadata.\n </p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding. </p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p>If you specify a preset in <code>PresetId</code> for which the value of\n <code>Container</code> is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 for the current output.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output file. \n For the current release, you can only specify settings for a single clip per output \n file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n \t<code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreateJobOutput</code> structure.</p>\n "
|
|
},
|
|
"Outputs": {
|
|
"shape_name": "CreateJobOutputs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CreateJobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> 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. </p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: <code>auto</code>, <code>0</code>,\n <code>90</code>, <code>180</code>, <code>270</code>. The value <code>auto</code>\n generally works only if the file that you're transcoding contains rotation metadata.\n </p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding. </p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p>If you specify a preset in <code>PresetId</code> for which the value of\n <code>Container</code> is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 for the current output.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output file. \n For the current release, you can only specify settings for a single clip per output \n file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n \t<code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreateJobOutput</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> A section of the request body that provides information about the transcoded (target)\n files. We recommend that you use the <code>Outputs</code> syntax instead of the\n <code>Output</code> syntax. </p>\n "
|
|
},
|
|
"OutputKeyPrefix": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The value, if any, that you want Elastic Transcoder to prepend to the names of all files\n that this job creates, including output files, thumbnails, and playlists.</p>\n "
|
|
},
|
|
"Playlists": {
|
|
"shape_name": "CreateJobPlaylists",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CreateJobPlaylist",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Filename",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all <code>Name</code> objects must be\n unique. Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in <code>Name</code>, it will appear twice in the file name. </p>\n "
|
|
},
|
|
"Format": {
|
|
"shape_name": "PlaylistFormat",
|
|
"type": "string",
|
|
"pattern": "(^HLSv3$)",
|
|
"documentation": "\n <p>This value must currently be HLSv3.</p>\n "
|
|
},
|
|
"OutputKeys": {
|
|
"shape_name": "OutputKeys",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>For each output in this job that you want to include in a master playlist, the value of\n the <code>Outputs:Key</code> object. If you include more than one output in a playlist,\n the value of <code>SegmentDuration</code> for all of the outputs must be the same.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the master playlist.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>If you specify a preset in <code>PresetId</code> for which the value of\n <code>Container</code> is ts (MPEG-TS), Playlists contains information about the\n master playlists that you want Elastic Transcoder to create.</p>\n <p>We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreateJobRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CreateJobResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Job": {
|
|
"shape_name": "Job",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
},
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> 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. </p>\n "
|
|
},
|
|
"Input": {
|
|
"shape_name": "JobInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> 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 <code>InputBucket</code> object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p>\n <p>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify <code>auto</code>. If you want to specify the frame rate for\n the input file, enter one of the following values: </p>\n <p>\n <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>\n </p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n the frame rate.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <p>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify <code>auto</code>. If you want to specify the aspect\n ratio for the output file, enter one of the following values: </p>\n <p>\n <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code>\n </p>\n <p> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection\n of the aspect ratio. </p>\n "
|
|
},
|
|
"Interlaced": {
|
|
"shape_name": "Interlaced",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify <code>auto</code>. If you want to specify whether\n the input file is interlaced, enter one of the following values:</p>\n <p><code>true</code>, <code>false</code></p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n interlacing.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "JobContainer",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)",
|
|
"documentation": "\n <p>The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify <code>auto</code>. If you want to specify the\n container type for the input file, enter one of the following values: </p>\n <p>\n <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, \n <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, \n <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, \n <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, \n <code>vob</code>, <code>wav</code>, <code>webm</code>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the request or response body that provides information about the file that\n is being transcoded.</p>\n "
|
|
},
|
|
"Output": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.</p>\n <p><important>Outputs recommended instead.</important> A section of the request or response\n body that provides information about the transcoded (target) file. </p>\n "
|
|
},
|
|
"Outputs": {
|
|
"shape_name": "JobOutputs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p><important>Outputs recommended instead.</important>If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n <code>Output</code> object lists information about the first output. This duplicates\n the information that is listed for the first output in the <code>Outputs</code>\n object.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Information about the output files. We recommend that you use the <code>Outputs</code>\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 <code>Outputs</code> and <code>Output</code> syntaxes in\n the same request. You can create a maximum of 30 outputs per job. </p>\n <p> If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.</p>\n "
|
|
},
|
|
"OutputKeyPrefix": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>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 <code>OutputKeyPrefix</code>.</p>\n "
|
|
},
|
|
"Playlists": {
|
|
"shape_name": "Playlists",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Playlist",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Filename",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all <code>Name</code> objects must be\n unique. <b>Note</b>: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in <code>Name</code>, it will appear twice in the file name.</p>\n "
|
|
},
|
|
"Format": {
|
|
"shape_name": "PlaylistFormat",
|
|
"type": "string",
|
|
"pattern": "(^HLSv3$)",
|
|
"documentation": "\n <p>This value must currently be <code>HLSv3</code>.</p>\n "
|
|
},
|
|
"OutputKeys": {
|
|
"shape_name": "OutputKeys",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n <code>SegmentDuration</code> for all of the outputs must be the same.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p>The status of the job with which the playlist is associated.</p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains the status.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is <code>ts</code> (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30. </p>\n "
|
|
},
|
|
"documentation": "\n <p><important>Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS),\n <code>Playlists</code> contains information about the master playlists that you want\n Elastic Transcoder to create.</p>\n <p>We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30. </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of the job: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>,\n <code>Canceled</code>, or <code>Error</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the response body that provides information about the job that is created.\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The CreateJobResponse structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "LimitExceededException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p> When you create a job, Elastic Transcoder returns JSON data that includes the values\n that you specified plus information about the job that is created. </p>\n <p>If you have specified more than one output for your jobs (for example, one output for the\n Kindle Fire and another output for the Apple iPhone 4s), you currently must use the\n Elastic Transcoder API to list the jobs (as opposed to the AWS Console).</p>\n <examples>\n <name>CreateJob Example</name>\n <example>\n <request>POST /2012-09-25/jobs HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Input\":{\n \"Key\":\"recipes/lasagna.mp4\", \"FrameRate\":\"auto\", \"Resolution\":\"auto\",\n \"AspectRatio\":\"auto\", \"Interlaced\":\"auto\", \"Container\":\"mp4\" },\n \"OutputKeyPrefix\":\"recipes/\", \"Outputs\":[ {\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Rotate\":\"0\",\n \"PresetId\":\"1351620000000-100080\" }, { \"Key\":\"iphone/lasagna-1024k\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Rotate\":\"0\",\n \"PresetId\":\"1351620000000-987654\", \"SegmentDuration\":\"5\" }, {\n \"Key\":\"iphone/lasagna-512k\", \"ThumbnailPattern\":\"iphone/th512k/lasagna-{count}\",\n \"Rotate\":\"0\", \"PresetId\":\"1351620000000-456789\", \"Watermarks\":[ {\n \"InputKey\":\"logo/128x64.png\", \"PresetWatermarkId\":\"company logo 128x64\" } ],\n \"SegmentDuration\":\"5\" } ], \"Playlists\": [ { \"Format\": \"HLSv3\", \"Name\":\n \"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\": [ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"PipelineId\":\"1111111111111-abcde1\" } </request>\n <response>Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Job\":{\n \"Id\":\"3333333333333-abcde3\" \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"2\", \"Key\":\"iphone/lasagna-1024k\",\n \"PresetId\":\"1351620000000-987654\", \"Rotate\":\"0\", \"SegmentDuration\":\"5\",\n \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Width\":\"1136\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\", \"Key\":\"iphone/lasagna-512k\",\n \"PresetId\":\"1351620000000-456789\", \"Watermarks\":[ {\n \"InputKey\":\"logo/128x64.png\", \"PresetWatermarkId\":\"company logo 128x64\" } ],\n \"Rotate\":\"0\", \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/lasagna-{count}\", \"Width\":\"1136\" } ],\n \"PipelineId\":\"1111111111111-abcde1\", \"Playlists\":[ { \"Format\":\"HLSv3\",\n \"Name\":\"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\": [ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"Status\":\"Progressing\" } </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreatePipeline": {
|
|
"name": "CreatePipeline",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/pipelines",
|
|
"response_code": 201
|
|
},
|
|
"input": {
|
|
"shape_name": "CreatePipelineRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters.</p>\n ",
|
|
"required": true
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket in which you saved the media files that you want to transcode.</p>\n ",
|
|
"required": true
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use\n ContentConfig:Bucket plus ThumbnailConfig:Bucket.)</p>\n <p>Specify this value when all of the following are true: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the\n files. <important>When Elastic Transcoder saves files in\n <code>OutputBucket</code>, it grants full control over the files only to\n the AWS account that owns the role that is specified by\n <code>Role</code>.</important>\n</li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul></p>\n <p>If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit <code>OutputBucket</code>\n and specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>\n instead.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the\n pipeline.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b>: 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.</li>\n <li>\n<b>Completed</b>: 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.</li>\n <li>\n<b>Warning</b>: 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.</li>\n <li>\n<b>Error</b>: 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.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The optional <code>ContentConfig</code> 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.</p>\n <p>If you specify values for <code>ContentConfig</code>, you must also specify values for\n <code>ThumbnailConfig</code>.</p>\n <p>If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>,\n omit the <code>OutputBucket</code> object.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b> (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.</li>\n <li>\n<b>Grantee Type</b>: Specify the type of value that appears in the\n <code>Grantee</code> object: <ul>\n <li>\n<b>Canonical</b>: The value in the <code>Grantee</code> 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. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n </li>\n <li>\n<b>Email</b>: The value in the <code>Grantee</code> object is the registered\n email address of an AWS account.</li>\n <li>\n<b>Group</b>: The value in the <code>Grantee</code> object is one of the\n following predefined Amazon S3 groups: <code>AllUsers</code>,\n <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n <b>Grantee</b>: 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 </li>\n <li>\n <b>Access</b>: The permission that you want to give to the AWS user that you\n specified in <code>Grantee</code>. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket. </li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n <li>\n <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the video files and playlists that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ThumbnailConfig</code> 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.</p>\n <p>If you specify values for <code>ContentConfig</code>, you must also specify values for\n <code>ThumbnailConfig</code> even if you don't want to create thumbnails.</p>\n <p>If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>,\n omit the <code>OutputBucket</code> object.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files.</li>\n <li>\n<b>Permissions</b> (Optional): The <code>Permissions</code> 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.</li>\n <li>\n <b>GranteeType</b>: Specify the type of value that appears in the Grantee object: <ul>\n <li>\n <b>Canonical</b>: The value in the <code>Grantee</code> object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. <important>A canonical user ID is not the\n same as an AWS account number.</important>\n</li>\n <li>\n<b>Email</b>: The value in the <code>Grantee</code> object is the registered\n email address of an AWS account. </li>\n <li>\n<b>Group</b>: The value in the <code>Grantee</code> object is one of the\n following predefined Amazon S3 groups: <code>AllUsers</code>,\n <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n <b>Grantee</b>: 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. </li>\n <li>\n <b>Access</b>: The permission that you want to give to the AWS user that you\n specified in <code>Grantee</code>. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket. </li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li>\n </ul>\n </li>\n <li>\n <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreatePipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CreatePipelineResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipeline": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the pipeline that is\n created.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>When you create a pipeline, Elastic Transcoder returns the values that you specified in the\n request.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "LimitExceededException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The CreatePipeline operation creates a pipeline with settings that you specify.</p>\n <examples>\n <example>\n <request>POST /2012-09-25/pipelines HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"Name\":\"Default\", \"InputBucket\":\"salesoffice.example.com-source\",\n \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Notifications\":{\n \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" } \"ContentConfig\":{\n \"Bucket\": \"My-S3-bucket\", \"Permissions\":[ { \"GranteeType\":\"Email\", \"Grantee\":\n \"marketing-promos@example.com\", \"Access\":[ \"Read\" ] } ],\n \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{ \"Bucket\":\"My-S3-bucket\",\n \"Permissions\":[ { \"GranteeType\":\"Email\",\n \"Grantee\":\"marketing-promos@example.com\", \"Access\":[ \"Read\" ] } ],\n \"StorageClass\":\"Standard\" } }</request>\n <response>Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipeline\":{\n Id\":\"1111111111111-abcde1\", \"InputBucket\":\"salesoffice.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ET_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos@example.com\", \"Access\":[\n \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice.example.com-public-promos-thumbnails\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos@example.com\", \"Access\":[\n \"FullControl\" ] } ], \"StorageClass\":\"ReducedRedundancy\" }, \"Status\":\"Active\" } }\n </response>\n </example>\n </examples>\n "
|
|
},
|
|
"CreatePreset": {
|
|
"name": "CreatePreset",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/presets",
|
|
"response_code": 201
|
|
},
|
|
"input": {
|
|
"shape_name": "CreatePresetRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the preset. We recommend that the name be unique within the AWS account, but\n uniqueness is not enforced.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A description of the preset.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "PresetContainer",
|
|
"type": "string",
|
|
"pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)",
|
|
"documentation": "\n <p>The container type for the output file. Valid values include <code>mp3</code>, \n <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Video": {
|
|
"shape_name": "VideoParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "VideoCodec",
|
|
"type": "string",
|
|
"pattern": "(^H\\.264$)|(^vp8$)",
|
|
"documentation": "\n <p>The video codec for the output file. Valid values include <code>H.264</code> and\n <code>vp8</code>. You can only specify <code>vp8</code> when the container type is\n <code>webm</code>.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "CodecOptions",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>\n <b>Profile</b>\n </p>\n <p>The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:</p>\n <ul>\n <li>\n<code>baseline</code>: The profile most commonly used for videoconferencing and for\n mobile applications.</li>\n <li>\n<code>main</code>: The profile used for standard-definition digital TV\n broadcasts.</li>\n <li>\n<code>high</code>: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.</li>\n </ul>\n <p>\n <b>Level (H.264 Only)</b>\n </p>\n <p>The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:</p>\n <p><code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>,\n <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>,\n <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code></p>\n <p>\n <b>MaxReferenceFrames (H.264 Only)</b>\n </p>\n <p>Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:</p>\n <p>\n <code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)</code>\n </p>\n <p>where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and\n MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends\n on the value of the <code>Level</code> object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.) </p>\n <ul>\n <li>1 - 396</li>\n <li>1b - 396</li>\n <li>1.1 - 900</li>\n <li>1.2 - 2376</li>\n <li>1.3 - 2376</li>\n <li>2 - 2376</li>\n <li>2.1 - 4752</li>\n <li>2.2 - 8100</li>\n <li>3 - 8100</li>\n <li>3.1 - 18000</li>\n <li>3.2 - 20480</li>\n <li>4 - 32768</li>\n <li>4.1 - 32768</li>\n </ul>\n <p>\n <b>MaxBitRate</b>\n </p>\n <p>The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by <code>BufferSize</code>. 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.</p>\n <p>\n <b>BufferSize</b>\n </p>\n <p>The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets\n <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>.</p>\n "
|
|
},
|
|
"KeyframesMaxDist": {
|
|
"shape_name": "KeyframesMaxDist",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,6}$",
|
|
"documentation": "\n <p>The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.</p>\n "
|
|
},
|
|
"FixedGOP": {
|
|
"shape_name": "FixedGOP",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether to use a fixed value for <code>FixedGOP</code>. Valid values are\n <code>true</code> and <code>false</code>:</p>\n <ul>\n <li>\n<code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).</li>\n <li>\n<code>false</code>: The distance between key frames can vary.</li>\n </ul>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "VideoBitRate",
|
|
"type": "string",
|
|
"pattern": "(^\\d{2,5}$)|(^auto$)",
|
|
"documentation": "\n <p>The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of <code>Level</code> and <code>Profile</code>. If you specify\n <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than <code>auto</code>, 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:</p>\n <p>\n <i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)</i>\n </p>\n <ul>\n <li>1 - 64 : 80</li>\n <li>1b - 128 : 160</li>\n <li>1.1 - 192 : 240</li>\n <li>1.2 - 384 : 480</li>\n <li>1.3 - 768 : 960</li>\n <li>2 - 2000 : 2500</li>\n <li>3 - 10000 : 12500</li>\n <li>3.1 - 14000 : 17500</li>\n <li>3.2 - 20000 : 25000</li>\n <li>4 - 20000 : 25000</li>\n <li>4.1 - 50000 : 62500</li>\n </ul>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frames per second for the video stream in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>,\n <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></p>\n <p>If you specify <code>auto</code>, 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:</p>\n <p>\n <code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)</code>\n </p>\n <p>where:</p>\n <ul>\n <li>\n<i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the\n output video.</li>\n <li>\n<i>maximum recommended decoding speed in Luma samples/second</i> 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.</li>\n </ul>\n <p>The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (<i>Level - Decoding speed</i>):</p>\n <ul>\n <li>1 - 380160</li>\n <li>1b - 380160</li>\n <li>1.1 - 76800</li>\n <li>1.2 - 1536000</li>\n <li>1.3 - 3041280</li>\n <li>2 - 3041280</li>\n <li>2.1 - 5068800</li>\n <li>2.2 - 5184000</li>\n <li>3 - 10368000</li>\n <li>3.1 - 27648000</li>\n <li>3.2 - 55296000</li>\n <li>4 - 62914560</li>\n <li>4.1 - 62914560</li>\n </ul>\n "
|
|
},
|
|
"MaxFrameRate": {
|
|
"shape_name": "MaxFrameRate",
|
|
"type": "string",
|
|
"pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>If you specify <code>auto</code> for <code>FrameRate</code>, 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: <code>10</code>,\n <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The width and height of the video in the output file, in pixels. Valid values are\n <code>auto</code> and <i>width</i> x <i>height</i>:</p>\n <ul>\n <li>\n<code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.</li>\n <li>\n<code><i>width</i> x <i>height</i></code>: The width and height of the output video\n in pixels.</li>\n </ul>\n <p>Note the following about specifying the width and height:</p>\n <ul>\n <li>The width must be an even integer between 128 and 4096, inclusive.</li>\n <li>The height must be an even integer between 96 and 3072, inclusive.</li>\n <li>If 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.</li>\n <li>If you specify a resolution that is greater than the resolution of the input file,\n Elastic Transcoder rescales the output to the higher resolution.</li>\n <li>We 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 (<i>List - Max\n width x height value</i>):</li>\n <ul>\n <li>1 - 25344</li>\n <li>1b - 25344</li>\n <li>1.1 - 101376</li>\n <li>1.2 - 101376</li>\n <li>1.3 - 101376</li>\n <li>2 - 101376</li>\n <li>2.1 - 202752</li>\n <li>2.2 - 404720</li>\n <li>3 - 404720</li>\n <li>3.1 - 921600</li>\n <li>3.2 - 1310720</li>\n <li>4 - 2097152</li>\n <li>4.1 - 2097152</li>\n </ul>\n </ul>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The display aspect ratio of the video in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.</p>\n <p>If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p> The maximum width of the output video in pixels. If you specify <code>auto</code>, 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. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output video in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"DisplayAspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p>The value that Elastic Transcoder adds to the metadata in the output file.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output video:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that\n you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output\n video.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code>\n and <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "PresetWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "PresetWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": " A unique identifier for the settings for one\n watermark. The value of <code>Id</code> can be up to 40 characters long. "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "WatermarkSizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
|
|
"documentation": "\n <p>A value that controls scaling of the watermark: <ul>\n <li>\n<b>Fit</b>: Elastic Transcoder scales the watermark so it matches the value that\n you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<b>Stretch</b>: Elastic Transcoder stretches the watermark to match the values\n that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the watermark and the values of <code>MaxWidth</code>\n and <code>MaxHeight</code> are different, the watermark will be distorted.</li>\n <li>\n<b>ShrinkToFit</b>: Elastic Transcoder scales the watermark down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.</li>\n</ul>\n </p>\n "
|
|
},
|
|
"HorizontalAlign": {
|
|
"shape_name": "HorizontalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Left$)|(^Right$)|(^Center$)",
|
|
"documentation": "\n <p>The horizontal position of the watermark unless you specify a non-zero value for\n <code>HorizontalOffset</code>: <ul>\n <li>\n<b>Left</b>: The left edge of the watermark is aligned with the left border of\n the video.</li>\n <li>\n<b>Right</b>: The right edge of the watermark is aligned with the right border\n of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the left and right\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"HorizontalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. 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.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
},
|
|
"VerticalAlign": {
|
|
"shape_name": "VerticalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Top$)|(^Bottom$)|(^Center$)",
|
|
"documentation": "\n <p>The vertical position of the watermark unless you specify a non-zero value for\n <code>VerticalOffset</code>: <ul>\n <li>\n<b>Top</b>: The top edge of the watermark is aligned with the top border of the\n video.</li>\n <li>\n<b>Bottom</b>: The bottom edge of the watermark is aligned with the bottom\n border of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the top and bottom\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"VerticalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> 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.</p>\n "
|
|
},
|
|
"Opacity": {
|
|
"shape_name": "Opacity",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
"documentation": "\n <p>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 <code>Opacity</code> is float.</p>\n <p>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 <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
},
|
|
"Target": {
|
|
"shape_name": "Target",
|
|
"type": "string",
|
|
"pattern": "(^Content$)|(^Frame$)",
|
|
"documentation": "\n <p>A value that determines how Elastic Transcoder interprets values that you specified for\n <code>HorizontalOffset</code>, <code>VerticalOffset</code>, <code>MaxWidth</code>,\n and <code>MaxHeight</code>: <ul>\n<li>\n<b>Content</b>: <code>HorizontalOffset</code> and\n <code>VerticalOffset</code> values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n <code>MaxWidth</code> and <code>MaxHeight</code>, 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.</li>\n <li>\n<b>Frame</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code>\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.</li> In addition, <code>MaxWidth</code> and\n <code>MaxHeight</code>, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.</ul></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the request body that specifies the video parameters.</p>\n "
|
|
},
|
|
"Audio": {
|
|
"shape_name": "AudioParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "AudioCodec",
|
|
"type": "string",
|
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
},
|
|
"SampleRate": {
|
|
"shape_name": "AudioSampleRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)",
|
|
"documentation": "\n <p>The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:</p>\n <p><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>,\n <code>48000</code>, <code>96000</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</p>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "AudioBitRate",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}$",
|
|
"documentation": "\n <p>The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.</p>\n "
|
|
},
|
|
"Channels": {
|
|
"shape_name": "AudioChannels",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "AudioCodecOptions",
|
|
"type": "structure",
|
|
"members": {
|
|
"Profile": {
|
|
"shape_name": "AudioCodecProfile",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
"documentation": "\n <p>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</p>\n <p>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the request body that specifies the audio parameters.</p>\n "
|
|
},
|
|
"Thumbnails": {
|
|
"shape_name": "Thumbnails",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </p>\n <p>You specify whether you want Elastic Transcoder to create thumbnails when you create a job.</p>\n "
|
|
},
|
|
"Interval": {
|
|
"shape_name": "Digits",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}$",
|
|
"documentation": "\n <p>The number of seconds between thumbnails. Specify an integer value.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "ThumbnailResolution",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}x\\d{1,5}$",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The width and height of thumbnail files in pixels. Specify a value in the format\n <code><i>width</i></code> x <code><i>height</i></code> where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n <code>Video:Resolution</code> object.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The aspect ratio of thumbnails. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072. </p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of thumbnails:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: 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. </li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code>\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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail <code>MaxWidth</code> and\n <code>MaxHeight</code> settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic\n Transcoder crops the thumbnails.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and <code>MaxHeight</code> settings.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the request body that specifies the thumbnail parameters, if any.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreatePresetRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "CreatePresetResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Preset": {
|
|
"shape_name": "Preset",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the preset.</p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A description of the preset.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "PresetContainer",
|
|
"type": "string",
|
|
"pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)",
|
|
"documentation": "\n <p>The container type for the output file. Valid values include <code>mp3</code>,\n <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>\n "
|
|
},
|
|
"Audio": {
|
|
"shape_name": "AudioParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "AudioCodec",
|
|
"type": "string",
|
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
},
|
|
"SampleRate": {
|
|
"shape_name": "AudioSampleRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)",
|
|
"documentation": "\n <p>The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:</p>\n <p><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>,\n <code>48000</code>, <code>96000</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</p>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "AudioBitRate",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}$",
|
|
"documentation": "\n <p>The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.</p>\n "
|
|
},
|
|
"Channels": {
|
|
"shape_name": "AudioChannels",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "AudioCodecOptions",
|
|
"type": "structure",
|
|
"members": {
|
|
"Profile": {
|
|
"shape_name": "AudioCodecProfile",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
"documentation": "\n <p>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</p>\n <p>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
},
|
|
"Video": {
|
|
"shape_name": "VideoParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "VideoCodec",
|
|
"type": "string",
|
|
"pattern": "(^H\\.264$)|(^vp8$)",
|
|
"documentation": "\n <p>The video codec for the output file. Valid values include <code>H.264</code> and\n <code>vp8</code>. You can only specify <code>vp8</code> when the container type is\n <code>webm</code>.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "CodecOptions",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>\n <b>Profile</b>\n </p>\n <p>The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:</p>\n <ul>\n <li>\n<code>baseline</code>: The profile most commonly used for videoconferencing and for\n mobile applications.</li>\n <li>\n<code>main</code>: The profile used for standard-definition digital TV\n broadcasts.</li>\n <li>\n<code>high</code>: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.</li>\n </ul>\n <p>\n <b>Level (H.264 Only)</b>\n </p>\n <p>The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:</p>\n <p><code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>,\n <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>,\n <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code></p>\n <p>\n <b>MaxReferenceFrames (H.264 Only)</b>\n </p>\n <p>Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:</p>\n <p>\n <code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)</code>\n </p>\n <p>where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and\n MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends\n on the value of the <code>Level</code> object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.) </p>\n <ul>\n <li>1 - 396</li>\n <li>1b - 396</li>\n <li>1.1 - 900</li>\n <li>1.2 - 2376</li>\n <li>1.3 - 2376</li>\n <li>2 - 2376</li>\n <li>2.1 - 4752</li>\n <li>2.2 - 8100</li>\n <li>3 - 8100</li>\n <li>3.1 - 18000</li>\n <li>3.2 - 20480</li>\n <li>4 - 32768</li>\n <li>4.1 - 32768</li>\n </ul>\n <p>\n <b>MaxBitRate</b>\n </p>\n <p>The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by <code>BufferSize</code>. 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.</p>\n <p>\n <b>BufferSize</b>\n </p>\n <p>The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets\n <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>.</p>\n "
|
|
},
|
|
"KeyframesMaxDist": {
|
|
"shape_name": "KeyframesMaxDist",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,6}$",
|
|
"documentation": "\n <p>The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.</p>\n "
|
|
},
|
|
"FixedGOP": {
|
|
"shape_name": "FixedGOP",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether to use a fixed value for <code>FixedGOP</code>. Valid values are\n <code>true</code> and <code>false</code>:</p>\n <ul>\n <li>\n<code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).</li>\n <li>\n<code>false</code>: The distance between key frames can vary.</li>\n </ul>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "VideoBitRate",
|
|
"type": "string",
|
|
"pattern": "(^\\d{2,5}$)|(^auto$)",
|
|
"documentation": "\n <p>The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of <code>Level</code> and <code>Profile</code>. If you specify\n <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than <code>auto</code>, 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:</p>\n <p>\n <i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)</i>\n </p>\n <ul>\n <li>1 - 64 : 80</li>\n <li>1b - 128 : 160</li>\n <li>1.1 - 192 : 240</li>\n <li>1.2 - 384 : 480</li>\n <li>1.3 - 768 : 960</li>\n <li>2 - 2000 : 2500</li>\n <li>3 - 10000 : 12500</li>\n <li>3.1 - 14000 : 17500</li>\n <li>3.2 - 20000 : 25000</li>\n <li>4 - 20000 : 25000</li>\n <li>4.1 - 50000 : 62500</li>\n </ul>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frames per second for the video stream in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>,\n <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></p>\n <p>If you specify <code>auto</code>, 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:</p>\n <p>\n <code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)</code>\n </p>\n <p>where:</p>\n <ul>\n <li>\n<i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the\n output video.</li>\n <li>\n<i>maximum recommended decoding speed in Luma samples/second</i> 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.</li>\n </ul>\n <p>The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (<i>Level - Decoding speed</i>):</p>\n <ul>\n <li>1 - 380160</li>\n <li>1b - 380160</li>\n <li>1.1 - 76800</li>\n <li>1.2 - 1536000</li>\n <li>1.3 - 3041280</li>\n <li>2 - 3041280</li>\n <li>2.1 - 5068800</li>\n <li>2.2 - 5184000</li>\n <li>3 - 10368000</li>\n <li>3.1 - 27648000</li>\n <li>3.2 - 55296000</li>\n <li>4 - 62914560</li>\n <li>4.1 - 62914560</li>\n </ul>\n "
|
|
},
|
|
"MaxFrameRate": {
|
|
"shape_name": "MaxFrameRate",
|
|
"type": "string",
|
|
"pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>If you specify <code>auto</code> for <code>FrameRate</code>, 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: <code>10</code>,\n <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The width and height of the video in the output file, in pixels. Valid values are\n <code>auto</code> and <i>width</i> x <i>height</i>:</p>\n <ul>\n <li>\n<code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.</li>\n <li>\n<code><i>width</i> x <i>height</i></code>: The width and height of the output video\n in pixels.</li>\n </ul>\n <p>Note the following about specifying the width and height:</p>\n <ul>\n <li>The width must be an even integer between 128 and 4096, inclusive.</li>\n <li>The height must be an even integer between 96 and 3072, inclusive.</li>\n <li>If 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.</li>\n <li>If you specify a resolution that is greater than the resolution of the input file,\n Elastic Transcoder rescales the output to the higher resolution.</li>\n <li>We 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 (<i>List - Max\n width x height value</i>):</li>\n <ul>\n <li>1 - 25344</li>\n <li>1b - 25344</li>\n <li>1.1 - 101376</li>\n <li>1.2 - 101376</li>\n <li>1.3 - 101376</li>\n <li>2 - 101376</li>\n <li>2.1 - 202752</li>\n <li>2.2 - 404720</li>\n <li>3 - 404720</li>\n <li>3.1 - 921600</li>\n <li>3.2 - 1310720</li>\n <li>4 - 2097152</li>\n <li>4.1 - 2097152</li>\n </ul>\n </ul>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The display aspect ratio of the video in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.</p>\n <p>If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p> The maximum width of the output video in pixels. If you specify <code>auto</code>, 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. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output video in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"DisplayAspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p>The value that Elastic Transcoder adds to the metadata in the output file.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output video:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that\n you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output\n video.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code>\n and <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "PresetWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "PresetWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": " A unique identifier for the settings for one\n watermark. The value of <code>Id</code> can be up to 40 characters long. "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "WatermarkSizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
|
|
"documentation": "\n <p>A value that controls scaling of the watermark: <ul>\n <li>\n<b>Fit</b>: Elastic Transcoder scales the watermark so it matches the value that\n you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<b>Stretch</b>: Elastic Transcoder stretches the watermark to match the values\n that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the watermark and the values of <code>MaxWidth</code>\n and <code>MaxHeight</code> are different, the watermark will be distorted.</li>\n <li>\n<b>ShrinkToFit</b>: Elastic Transcoder scales the watermark down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.</li>\n</ul>\n </p>\n "
|
|
},
|
|
"HorizontalAlign": {
|
|
"shape_name": "HorizontalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Left$)|(^Right$)|(^Center$)",
|
|
"documentation": "\n <p>The horizontal position of the watermark unless you specify a non-zero value for\n <code>HorizontalOffset</code>: <ul>\n <li>\n<b>Left</b>: The left edge of the watermark is aligned with the left border of\n the video.</li>\n <li>\n<b>Right</b>: The right edge of the watermark is aligned with the right border\n of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the left and right\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"HorizontalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. 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.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
},
|
|
"VerticalAlign": {
|
|
"shape_name": "VerticalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Top$)|(^Bottom$)|(^Center$)",
|
|
"documentation": "\n <p>The vertical position of the watermark unless you specify a non-zero value for\n <code>VerticalOffset</code>: <ul>\n <li>\n<b>Top</b>: The top edge of the watermark is aligned with the top border of the\n video.</li>\n <li>\n<b>Bottom</b>: The bottom edge of the watermark is aligned with the bottom\n border of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the top and bottom\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"VerticalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> 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.</p>\n "
|
|
},
|
|
"Opacity": {
|
|
"shape_name": "Opacity",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
"documentation": "\n <p>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 <code>Opacity</code> is float.</p>\n <p>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 <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
},
|
|
"Target": {
|
|
"shape_name": "Target",
|
|
"type": "string",
|
|
"pattern": "(^Content$)|(^Frame$)",
|
|
"documentation": "\n <p>A value that determines how Elastic Transcoder interprets values that you specified for\n <code>HorizontalOffset</code>, <code>VerticalOffset</code>, <code>MaxWidth</code>,\n and <code>MaxHeight</code>: <ul>\n<li>\n<b>Content</b>: <code>HorizontalOffset</code> and\n <code>VerticalOffset</code> values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n <code>MaxWidth</code> and <code>MaxHeight</code>, 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.</li>\n <li>\n<b>Frame</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code>\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.</li> In addition, <code>MaxWidth</code> and\n <code>MaxHeight</code>, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.</ul></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the video preset\n values.</p>\n "
|
|
},
|
|
"Thumbnails": {
|
|
"shape_name": "Thumbnails",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </p>\n <p>You specify whether you want Elastic Transcoder to create thumbnails when you create a job.</p>\n "
|
|
},
|
|
"Interval": {
|
|
"shape_name": "Digits",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}$",
|
|
"documentation": "\n <p>The number of seconds between thumbnails. Specify an integer value.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "ThumbnailResolution",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}x\\d{1,5}$",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The width and height of thumbnail files in pixels. Specify a value in the format\n <code><i>width</i></code> x <code><i>height</i></code> where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n <code>Video:Resolution</code> object.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The aspect ratio of thumbnails. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072. </p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of thumbnails:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: 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. </li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code>\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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail <code>MaxWidth</code> and\n <code>MaxHeight</code> settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic\n Transcoder crops the thumbnails.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and <code>MaxHeight</code> settings.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the thumbnail preset\n values, if any.</p>\n "
|
|
},
|
|
"Type": {
|
|
"shape_name": "PresetType",
|
|
"type": "string",
|
|
"pattern": "(^System$)|(^Custom$)",
|
|
"documentation": "\n <p>Whether the preset is a default preset provided by Elastic Transcoder\n (<code>System</code>) or a preset that you have defined (<code>Custom</code>).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the response body that provides information about the preset that is\n created. </p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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 acceptable\n output.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>CreatePresetResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "LimitExceededException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The CreatePreset operation creates a preset with settings that you specify.</p>\n <important>Elastic 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 (<code>ValidationException</code>) 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.</important>\n <p>Elastic Transcoder uses the H.264 video-compression format. For more information, see the International\n Telecommunication Union publication <i>Recommendation ITU-T H.264: Advanced video coding\n for generic audiovisual services</i>.</p>\n <examples>\n <example>\n <request>POST /2012-09-25/presets HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"Name\":\"DefaultPreset\", \"Description\":\"Use for published videos\",\n \"Container\":\"mp4\", \"Audio\":{ \"Codec\":\"AAC\", \"SampleRate\":\"44100\",\n \"BitRate\":\"96\", \"Channels\":\"2\" }, \"Video\":{ \"Codec\":\"H.264\", \"CodecOptions\":{\n \"Profile\":\"main\", \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\", \"MaxBitRate\":\"\",\n \"BufferSize\":\"\" }, \"KeyframesMaxDist\":\"240\", \"FixedGOP\":\"false\",\n \"BitRate\":\"1600\", \"FrameRate\":\"30\", \"MaxWidth\": \"auto\", \"MaxHeight\": \"auto\",\n \"SizingPolicy\": \"Fit\", \"PaddingPolicy\": \"NoPad\", \"DisplayAspectRatio\": \"16:9\",\n \"Watermarks\":[ { \"Id\":\"company logo\", \"MaxWidth\":\"20%\", \"MaxHeight\":\"20%\",\n \"SizingPolicy\":\"ShrinkToFit\", \"HorizontalAlign\":\"Right\",\n \"HorizontalOffset\":\"10px\", \"VerticalAlign\":\"Bottom\", \"VerticalOffset\":\"10px\",\n \"Opacity\":\"55.5\", \"Target\":\"Content\" } ]}, \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto, \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\",\n \"PaddingPolicy\": \"NoPad\" } }</request>\n <response>Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Preset\":{ \"Audio\":{\n \"BitRate\":\"96\", \"Channels\":\"2\", \"Codec\":\"AAC\", \"SampleRate\":\"44100\" },\n \"Container\":\"mp4\", \"Description\":\"Use for published videos\",\n \"Id\":\"5555555555555-abcde5\", \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto, \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\",\n \"PaddingPolicy\": \"NoPad\" }, \"Type\":\"Custom\", \"Video\":{ \"Codec\":\"H.264\",\n \"CodecOptions\":{ \"Profile\":\"main\", \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\",\n \"MaxBitRate\":\"\", \"BufferSize\":\"\" }, \"KeyframesMaxDist\":\"240\",\n \"FixedGOP\":\"false\", \"BitRate\":\"1600\", \"FrameRate\":\"30\", \"MaxWidth\": \"auto\",\n \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\", \"PaddingPolicy\": \"NoPad\",\n \"DisplayAspectRatio\": \"16:9\", \"Watermarks\":[ { \"Id\":\"company logo\",\n \"MaxWidth\":\"20%\", \"MaxHeight\":\"20%\", \"SizingPolicy\":\"ShrinkToFit\",\n \"HorizontalAlign\":\"Right\", \"HorizontalOffset\":\"10px\", \"VerticalAlign\":\"Bottom\",\n \"VerticalOffset\":\"10px\", \"Opacity\":\"55.5\", \"Target\":\"Content\" } ] } },\n \"Warning\":\"\" }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeletePipeline": {
|
|
"name": "DeletePipeline",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"uri": "/2012-09-25/pipelines/{Id}",
|
|
"response_code": 202
|
|
},
|
|
"input": {
|
|
"shape_name": "DeletePipelineRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the pipeline that you want to delete.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>DeletePipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DeletePipelineResponse",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The <code>DeletePipelineResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceInUseException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The DeletePipeline operation removes a pipeline.</p>\n <p> 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 <code>DeletePipeline</code> returns an error. </p>\n <examples>\n <example>\n <request>DELETE /2012-09-25/pipelines/1111111111111-abcde1 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]</request>\n <response>Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" } </response>\n </example>\n </examples>\n "
|
|
},
|
|
"DeletePreset": {
|
|
"name": "DeletePreset",
|
|
"http": {
|
|
"method": "DELETE",
|
|
"uri": "/2012-09-25/presets/{Id}",
|
|
"response_code": 202
|
|
},
|
|
"input": {
|
|
"shape_name": "DeletePresetRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the preset for which you want to get detailed information.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>DeletePresetRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "DeletePresetResponse",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>The <code>DeletePresetResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The DeletePreset operation removes a preset that you've added in an AWS region.</p>\n <note>\n <p>You can't delete the default presets that are included with Elastic Transcoder.</p>\n </note>\n <examples>\n <example>\n <request>DELETE /2012-09-25/pipelines/5555555555555-abcde5 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response>Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"ListJobsByPipeline": {
|
|
"name": "ListJobsByPipeline",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/jobsByPipeline/{PipelineId}?Ascending={Ascending}&PageToken={PageToken}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ListJobsByPipelineRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The ID of the pipeline for which you want to get job information. </p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
},
|
|
"Ascending": {
|
|
"shape_name": "Ascending",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p> To list jobs in chronological order by the date and time that they were submitted, enter\n <code>true</code>. To list jobs in reverse chronological order, enter\n <code>false</code>. </p>\n ",
|
|
"location": "uri"
|
|
},
|
|
"PageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListJobsByPipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListJobsByPipelineResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Jobs": {
|
|
"shape_name": "Jobs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Job",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
},
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> 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. </p>\n "
|
|
},
|
|
"Input": {
|
|
"shape_name": "JobInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> 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 <code>InputBucket</code> object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p>\n <p>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify <code>auto</code>. If you want to specify the frame rate for\n the input file, enter one of the following values: </p>\n <p>\n <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>\n </p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n the frame rate.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <p>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify <code>auto</code>. If you want to specify the aspect\n ratio for the output file, enter one of the following values: </p>\n <p>\n <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code>\n </p>\n <p> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection\n of the aspect ratio. </p>\n "
|
|
},
|
|
"Interlaced": {
|
|
"shape_name": "Interlaced",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify <code>auto</code>. If you want to specify whether\n the input file is interlaced, enter one of the following values:</p>\n <p><code>true</code>, <code>false</code></p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n interlacing.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "JobContainer",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)",
|
|
"documentation": "\n <p>The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify <code>auto</code>. If you want to specify the\n container type for the input file, enter one of the following values: </p>\n <p>\n <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, \n <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, \n <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, \n <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, \n <code>vob</code>, <code>wav</code>, <code>webm</code>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the request or response body that provides information about the file that\n is being transcoded.</p>\n "
|
|
},
|
|
"Output": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.</p>\n <p><important>Outputs recommended instead.</important> A section of the request or response\n body that provides information about the transcoded (target) file. </p>\n "
|
|
},
|
|
"Outputs": {
|
|
"shape_name": "JobOutputs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p><important>Outputs recommended instead.</important>If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n <code>Output</code> object lists information about the first output. This duplicates\n the information that is listed for the first output in the <code>Outputs</code>\n object.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Information about the output files. We recommend that you use the <code>Outputs</code>\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 <code>Outputs</code> and <code>Output</code> syntaxes in\n the same request. You can create a maximum of 30 outputs per job. </p>\n <p> If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.</p>\n "
|
|
},
|
|
"OutputKeyPrefix": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>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 <code>OutputKeyPrefix</code>.</p>\n "
|
|
},
|
|
"Playlists": {
|
|
"shape_name": "Playlists",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Playlist",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Filename",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all <code>Name</code> objects must be\n unique. <b>Note</b>: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in <code>Name</code>, it will appear twice in the file name.</p>\n "
|
|
},
|
|
"Format": {
|
|
"shape_name": "PlaylistFormat",
|
|
"type": "string",
|
|
"pattern": "(^HLSv3$)",
|
|
"documentation": "\n <p>This value must currently be <code>HLSv3</code>.</p>\n "
|
|
},
|
|
"OutputKeys": {
|
|
"shape_name": "OutputKeys",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n <code>SegmentDuration</code> for all of the outputs must be the same.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p>The status of the job with which the playlist is associated.</p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains the status.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is <code>ts</code> (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30. </p>\n "
|
|
},
|
|
"documentation": "\n <p><important>Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS),\n <code>Playlists</code> contains information about the master playlists that you want\n Elastic Transcoder to create.</p>\n <p>We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30. </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of the job: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>,\n <code>Canceled</code>, or <code>Error</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the job that is\n created.</p>\n "
|
|
},
|
|
"documentation": "\n <p>An array of <code>Job</code> objects that are in the specified pipeline.</p>\n "
|
|
},
|
|
"NextPageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> 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 <code>NextPageToken</code> is <code>null</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListJobsByPipelineResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.</p>\n <p>Elastic Transcoder returns all of the jobs currently in the specified pipeline. The\n response body contains one element for each job that satisfies the search criteria.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/jobsByPipeline/1111111111111-abcde1?Ascending=true HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Jobs\":[ { \"Id\":\"3333333333333-abcde3\",\n \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\", \"Resolution\":\"auto\" },\n \"Outputs \":[ { \"Id\":\"1\" \"Key\":\"cooking/lasagna-KindleFireHD.mp4\",\n \"PresetId\":\"5555555555555-abcde5\", \"Rotate\":\"0\", \"Status\":\"Submitted\",\n \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-KindleFireHD\", \"Duration\":\"1003\",\n \"Width\":\"1280\", \"Height\":\"720\" }, { \"Id\":\"2\"\n \"Key\":\"cooking/lasagna-iPhone4s.mp4\", \"PresetId\":\"1351620000000-100020\",\n \"Rotate\":\"0\", \"Status\":\"Submitted\", \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-iPhone4s\", \"Duration\":\"1003\",\n \"Width\":\"1920\", \"Height\":\"1080\" } ], \"Output\":{\n \"Key\":\"cooking/lasagna-KindleFireHD.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Submitted\", \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-KindleFireHD\" },\n \"PipelineId\":\"1111111111111-abcde1\" }, { \"Id\":\"4444444444444-abcde4\", \"Input\":{\n \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/baked-ziti.mp4\", \"Resolution\":\"auto\" },\n \"Outputs\":[ { \"Id\":\"1\" \"Key\":\"cooking/baked-ziti-KindleFireHD.mp4\",\n \"PresetId\":\"1351620000000-100080\", \"Rotate\":\"0\", \"Status\":\"Complete\",\n \"StatusDetail\":\"\", \"ThumbnailPattern\":\"cooking/baked-ziti-{count}-KindleFireHD\",\n \"Duration\":\"596\", \"Width\":\"1280\", \"Height\":\"720\" } ], \"Output\":{\n \"Key\":\"cooking/baked-ziti-KindleFireHD.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"cooking/baked-ziti-{count}-KindleFireHD\" },\n \"PipelineId\":\"1111111111111-abcde1\" } ], \"NextPageToken\":null </response>\n </example>\n </examples>\n ",
|
|
"pagination": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Jobs",
|
|
"py_input_token": "page_token"
|
|
}
|
|
},
|
|
"ListJobsByStatus": {
|
|
"name": "ListJobsByStatus",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/jobsByStatus/{Status}?Ascending={Ascending}&PageToken={PageToken}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ListJobsByStatusRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p>To get information about all of the jobs associated with the current AWS account that\n have a given status, specify the following status: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
},
|
|
"Ascending": {
|
|
"shape_name": "Ascending",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p> To list jobs in chronological order by the date and time that they were submitted, enter\n <code>true</code>. To list jobs in reverse chronological order, enter\n <code>false</code>. </p>\n ",
|
|
"location": "uri"
|
|
},
|
|
"PageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListJobsByStatusRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListJobsByStatusResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Jobs": {
|
|
"shape_name": "Jobs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Job",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
},
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> 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. </p>\n "
|
|
},
|
|
"Input": {
|
|
"shape_name": "JobInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> 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 <code>InputBucket</code> object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p>\n <p>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify <code>auto</code>. If you want to specify the frame rate for\n the input file, enter one of the following values: </p>\n <p>\n <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>\n </p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n the frame rate.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <p>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify <code>auto</code>. If you want to specify the aspect\n ratio for the output file, enter one of the following values: </p>\n <p>\n <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code>\n </p>\n <p> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection\n of the aspect ratio. </p>\n "
|
|
},
|
|
"Interlaced": {
|
|
"shape_name": "Interlaced",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify <code>auto</code>. If you want to specify whether\n the input file is interlaced, enter one of the following values:</p>\n <p><code>true</code>, <code>false</code></p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n interlacing.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "JobContainer",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)",
|
|
"documentation": "\n <p>The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify <code>auto</code>. If you want to specify the\n container type for the input file, enter one of the following values: </p>\n <p>\n <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, \n <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, \n <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, \n <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, \n <code>vob</code>, <code>wav</code>, <code>webm</code>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the request or response body that provides information about the file that\n is being transcoded.</p>\n "
|
|
},
|
|
"Output": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.</p>\n <p><important>Outputs recommended instead.</important> A section of the request or response\n body that provides information about the transcoded (target) file. </p>\n "
|
|
},
|
|
"Outputs": {
|
|
"shape_name": "JobOutputs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p><important>Outputs recommended instead.</important>If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n <code>Output</code> object lists information about the first output. This duplicates\n the information that is listed for the first output in the <code>Outputs</code>\n object.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Information about the output files. We recommend that you use the <code>Outputs</code>\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 <code>Outputs</code> and <code>Output</code> syntaxes in\n the same request. You can create a maximum of 30 outputs per job. </p>\n <p> If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.</p>\n "
|
|
},
|
|
"OutputKeyPrefix": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>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 <code>OutputKeyPrefix</code>.</p>\n "
|
|
},
|
|
"Playlists": {
|
|
"shape_name": "Playlists",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Playlist",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Filename",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all <code>Name</code> objects must be\n unique. <b>Note</b>: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in <code>Name</code>, it will appear twice in the file name.</p>\n "
|
|
},
|
|
"Format": {
|
|
"shape_name": "PlaylistFormat",
|
|
"type": "string",
|
|
"pattern": "(^HLSv3$)",
|
|
"documentation": "\n <p>This value must currently be <code>HLSv3</code>.</p>\n "
|
|
},
|
|
"OutputKeys": {
|
|
"shape_name": "OutputKeys",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n <code>SegmentDuration</code> for all of the outputs must be the same.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p>The status of the job with which the playlist is associated.</p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains the status.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is <code>ts</code> (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30. </p>\n "
|
|
},
|
|
"documentation": "\n <p><important>Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS),\n <code>Playlists</code> contains information about the master playlists that you want\n Elastic Transcoder to create.</p>\n <p>We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30. </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of the job: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>,\n <code>Canceled</code>, or <code>Error</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the job that is\n created.</p>\n "
|
|
},
|
|
"documentation": "\n <p>An array of <code>Job</code> objects that have the specified status.</p>\n "
|
|
},
|
|
"NextPageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> 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 <code>NextPageToken</code> is <code>null</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>\n The <code>ListJobsByStatusResponse</code> structure.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ListJobsByStatus operation gets a list of jobs that have a specified status. The\n response body contains one element for each job that satisfies the search criteria.</p>\n <examples>\n <example>\n <request> GET /2012-09-25/jobsByStatus/Complete?Ascending=true HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response> Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Jobs\":[ {\n \"Id\":\"3333333333333-abcde3\", \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"2\", \"Key\":\"iphone/lasagna-1024k\",\n \"PresetId\":\"1351620000000-987654\", \"Rotate\":\"0\", \"SegmentDuration\":\"5\",\n \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Width\":\"1136\" }, ],\n \"PipelineId\":\"1111111111111-abcde1\", \"Playlists\":[ { \"Format\":\"HLSv3\",\n \"Name\":\"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\":[ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"Status\":\"Complete\" }, {\n \"Id\":\"4444444444444-abcde4\", \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/spaghetti.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\",\n \"Key\":\"iphone/spaghetti-512k\", \"PresetId\":\"1351620000000-456789\", \"Rotate\":\"0\",\n \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/spaghetti-{count}\", \"Width\":\"1136\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\",\n \"Key\":\"iphone/spaghetti-512k\", \"PresetId\":\"1351620000000-456789\", \"Rotate\":\"0\",\n \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/spaghetti-{count}\", \"Width\":\"1136\" } ],\n \"Playlists\":[ { \"Format\":\"HLSv3\", \"Name\":\"playlist-iPhone-spaghetti.m3u8\",\n \"OutputKeys\":[ \"iphone/spaghetti-512k\" ] } ], \"Status\":\"Complete\" } ],\n \"NextPageToken\":null }</response>\n </example>\n </examples>\n ",
|
|
"pagination": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Jobs",
|
|
"py_input_token": "page_token"
|
|
}
|
|
},
|
|
"ListPipelines": {
|
|
"name": "ListPipelines",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/pipelines?Ascending={Ascending}&PageToken={PageToken}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ListPipelinesRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Ascending": {
|
|
"shape_name": "Ascending",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>To list pipelines in chronological order by the date and time that they were created, enter\n <code>true</code>. To list pipelines in reverse chronological order, enter\n <code>false</code>.</p>\n ",
|
|
"location": "uri"
|
|
},
|
|
"PageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListPipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListPipelinesResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipelines": {
|
|
"shape_name": "Pipelines",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The pipeline (queue) that is used to manage jobs.</p>\n "
|
|
},
|
|
"documentation": "\n <p>An array of <code>Pipeline</code> objects.</p>\n "
|
|
},
|
|
"NextPageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>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 <code>NextPageToken</code> is <code>null</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A list of the pipelines associated with the current AWS account.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ListPipelines operation gets a list of the pipelines associated with the current AWS\n account.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/pipelines HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipelines\":[ {\n \"Id\":\"1111111111111-abcde1\", \"Name\":\"Tokyo-Default\",\n \"InputBucket\":\"salesoffice-tokyo.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Notifications\":{ \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice-tokyo.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-tokyo@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice-tokyo.example.com-public-promos-thumbnails\",\n \"Permissions\":[ { \"GranteeType\":\"Email\",\n \"Grantee\":\"marketing-promos-tokyo@example.com\", \"Access\":[ \"FullControl\" ] } ],\n \"StorageClass\":\"ReducedRedundancy\" }, \"Status\":\"Active\" }, {\n \"Id\":\"2222222222222-abcde2\", \"Name\":\"Amsterdam-Default\",\n \"InputBucket\":\"salesoffice-amsterdam.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Notifications\":{ \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice-amsterdam.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-amsterdam@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, nails\",\n \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice-amsterdam.example.com-public-promos-thumb \"Permissions\":[\n { \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-amsterdam@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"ReducedRedundancy\" },\n \"Status\":\"Active\" } ] } </response>\n </example>\n </examples>\n ",
|
|
"pagination": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Pipelines",
|
|
"py_input_token": "page_token"
|
|
}
|
|
},
|
|
"ListPresets": {
|
|
"name": "ListPresets",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/presets?Ascending={Ascending}&PageToken={PageToken}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ListPresetsRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Ascending": {
|
|
"shape_name": "Ascending",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>To list presets in chronological order by the date and time that they were created, enter\n <code>true</code>. To list presets in reverse chronological order, enter\n <code>false</code>.</p>\n ",
|
|
"location": "uri"
|
|
},
|
|
"PageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListPresetsRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ListPresetsResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Presets": {
|
|
"shape_name": "Presets",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Preset",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the preset.</p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A description of the preset.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "PresetContainer",
|
|
"type": "string",
|
|
"pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)",
|
|
"documentation": "\n <p>The container type for the output file. Valid values include <code>mp3</code>,\n <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>\n "
|
|
},
|
|
"Audio": {
|
|
"shape_name": "AudioParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "AudioCodec",
|
|
"type": "string",
|
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
},
|
|
"SampleRate": {
|
|
"shape_name": "AudioSampleRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)",
|
|
"documentation": "\n <p>The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:</p>\n <p><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>,\n <code>48000</code>, <code>96000</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</p>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "AudioBitRate",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}$",
|
|
"documentation": "\n <p>The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.</p>\n "
|
|
},
|
|
"Channels": {
|
|
"shape_name": "AudioChannels",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "AudioCodecOptions",
|
|
"type": "structure",
|
|
"members": {
|
|
"Profile": {
|
|
"shape_name": "AudioCodecProfile",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
"documentation": "\n <p>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</p>\n <p>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
},
|
|
"Video": {
|
|
"shape_name": "VideoParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "VideoCodec",
|
|
"type": "string",
|
|
"pattern": "(^H\\.264$)|(^vp8$)",
|
|
"documentation": "\n <p>The video codec for the output file. Valid values include <code>H.264</code> and\n <code>vp8</code>. You can only specify <code>vp8</code> when the container type is\n <code>webm</code>.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "CodecOptions",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>\n <b>Profile</b>\n </p>\n <p>The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:</p>\n <ul>\n <li>\n<code>baseline</code>: The profile most commonly used for videoconferencing and for\n mobile applications.</li>\n <li>\n<code>main</code>: The profile used for standard-definition digital TV\n broadcasts.</li>\n <li>\n<code>high</code>: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.</li>\n </ul>\n <p>\n <b>Level (H.264 Only)</b>\n </p>\n <p>The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:</p>\n <p><code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>,\n <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>,\n <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code></p>\n <p>\n <b>MaxReferenceFrames (H.264 Only)</b>\n </p>\n <p>Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:</p>\n <p>\n <code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)</code>\n </p>\n <p>where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and\n MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends\n on the value of the <code>Level</code> object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.) </p>\n <ul>\n <li>1 - 396</li>\n <li>1b - 396</li>\n <li>1.1 - 900</li>\n <li>1.2 - 2376</li>\n <li>1.3 - 2376</li>\n <li>2 - 2376</li>\n <li>2.1 - 4752</li>\n <li>2.2 - 8100</li>\n <li>3 - 8100</li>\n <li>3.1 - 18000</li>\n <li>3.2 - 20480</li>\n <li>4 - 32768</li>\n <li>4.1 - 32768</li>\n </ul>\n <p>\n <b>MaxBitRate</b>\n </p>\n <p>The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by <code>BufferSize</code>. 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.</p>\n <p>\n <b>BufferSize</b>\n </p>\n <p>The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets\n <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>.</p>\n "
|
|
},
|
|
"KeyframesMaxDist": {
|
|
"shape_name": "KeyframesMaxDist",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,6}$",
|
|
"documentation": "\n <p>The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.</p>\n "
|
|
},
|
|
"FixedGOP": {
|
|
"shape_name": "FixedGOP",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether to use a fixed value for <code>FixedGOP</code>. Valid values are\n <code>true</code> and <code>false</code>:</p>\n <ul>\n <li>\n<code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).</li>\n <li>\n<code>false</code>: The distance between key frames can vary.</li>\n </ul>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "VideoBitRate",
|
|
"type": "string",
|
|
"pattern": "(^\\d{2,5}$)|(^auto$)",
|
|
"documentation": "\n <p>The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of <code>Level</code> and <code>Profile</code>. If you specify\n <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than <code>auto</code>, 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:</p>\n <p>\n <i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)</i>\n </p>\n <ul>\n <li>1 - 64 : 80</li>\n <li>1b - 128 : 160</li>\n <li>1.1 - 192 : 240</li>\n <li>1.2 - 384 : 480</li>\n <li>1.3 - 768 : 960</li>\n <li>2 - 2000 : 2500</li>\n <li>3 - 10000 : 12500</li>\n <li>3.1 - 14000 : 17500</li>\n <li>3.2 - 20000 : 25000</li>\n <li>4 - 20000 : 25000</li>\n <li>4.1 - 50000 : 62500</li>\n </ul>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frames per second for the video stream in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>,\n <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></p>\n <p>If you specify <code>auto</code>, 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:</p>\n <p>\n <code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)</code>\n </p>\n <p>where:</p>\n <ul>\n <li>\n<i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the\n output video.</li>\n <li>\n<i>maximum recommended decoding speed in Luma samples/second</i> 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.</li>\n </ul>\n <p>The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (<i>Level - Decoding speed</i>):</p>\n <ul>\n <li>1 - 380160</li>\n <li>1b - 380160</li>\n <li>1.1 - 76800</li>\n <li>1.2 - 1536000</li>\n <li>1.3 - 3041280</li>\n <li>2 - 3041280</li>\n <li>2.1 - 5068800</li>\n <li>2.2 - 5184000</li>\n <li>3 - 10368000</li>\n <li>3.1 - 27648000</li>\n <li>3.2 - 55296000</li>\n <li>4 - 62914560</li>\n <li>4.1 - 62914560</li>\n </ul>\n "
|
|
},
|
|
"MaxFrameRate": {
|
|
"shape_name": "MaxFrameRate",
|
|
"type": "string",
|
|
"pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>If you specify <code>auto</code> for <code>FrameRate</code>, 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: <code>10</code>,\n <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The width and height of the video in the output file, in pixels. Valid values are\n <code>auto</code> and <i>width</i> x <i>height</i>:</p>\n <ul>\n <li>\n<code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.</li>\n <li>\n<code><i>width</i> x <i>height</i></code>: The width and height of the output video\n in pixels.</li>\n </ul>\n <p>Note the following about specifying the width and height:</p>\n <ul>\n <li>The width must be an even integer between 128 and 4096, inclusive.</li>\n <li>The height must be an even integer between 96 and 3072, inclusive.</li>\n <li>If 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.</li>\n <li>If you specify a resolution that is greater than the resolution of the input file,\n Elastic Transcoder rescales the output to the higher resolution.</li>\n <li>We 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 (<i>List - Max\n width x height value</i>):</li>\n <ul>\n <li>1 - 25344</li>\n <li>1b - 25344</li>\n <li>1.1 - 101376</li>\n <li>1.2 - 101376</li>\n <li>1.3 - 101376</li>\n <li>2 - 101376</li>\n <li>2.1 - 202752</li>\n <li>2.2 - 404720</li>\n <li>3 - 404720</li>\n <li>3.1 - 921600</li>\n <li>3.2 - 1310720</li>\n <li>4 - 2097152</li>\n <li>4.1 - 2097152</li>\n </ul>\n </ul>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The display aspect ratio of the video in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.</p>\n <p>If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p> The maximum width of the output video in pixels. If you specify <code>auto</code>, 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. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output video in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"DisplayAspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p>The value that Elastic Transcoder adds to the metadata in the output file.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output video:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that\n you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output\n video.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code>\n and <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "PresetWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "PresetWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": " A unique identifier for the settings for one\n watermark. The value of <code>Id</code> can be up to 40 characters long. "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "WatermarkSizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
|
|
"documentation": "\n <p>A value that controls scaling of the watermark: <ul>\n <li>\n<b>Fit</b>: Elastic Transcoder scales the watermark so it matches the value that\n you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<b>Stretch</b>: Elastic Transcoder stretches the watermark to match the values\n that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the watermark and the values of <code>MaxWidth</code>\n and <code>MaxHeight</code> are different, the watermark will be distorted.</li>\n <li>\n<b>ShrinkToFit</b>: Elastic Transcoder scales the watermark down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.</li>\n</ul>\n </p>\n "
|
|
},
|
|
"HorizontalAlign": {
|
|
"shape_name": "HorizontalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Left$)|(^Right$)|(^Center$)",
|
|
"documentation": "\n <p>The horizontal position of the watermark unless you specify a non-zero value for\n <code>HorizontalOffset</code>: <ul>\n <li>\n<b>Left</b>: The left edge of the watermark is aligned with the left border of\n the video.</li>\n <li>\n<b>Right</b>: The right edge of the watermark is aligned with the right border\n of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the left and right\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"HorizontalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. 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.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
},
|
|
"VerticalAlign": {
|
|
"shape_name": "VerticalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Top$)|(^Bottom$)|(^Center$)",
|
|
"documentation": "\n <p>The vertical position of the watermark unless you specify a non-zero value for\n <code>VerticalOffset</code>: <ul>\n <li>\n<b>Top</b>: The top edge of the watermark is aligned with the top border of the\n video.</li>\n <li>\n<b>Bottom</b>: The bottom edge of the watermark is aligned with the bottom\n border of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the top and bottom\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"VerticalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> 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.</p>\n "
|
|
},
|
|
"Opacity": {
|
|
"shape_name": "Opacity",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
"documentation": "\n <p>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 <code>Opacity</code> is float.</p>\n <p>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 <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
},
|
|
"Target": {
|
|
"shape_name": "Target",
|
|
"type": "string",
|
|
"pattern": "(^Content$)|(^Frame$)",
|
|
"documentation": "\n <p>A value that determines how Elastic Transcoder interprets values that you specified for\n <code>HorizontalOffset</code>, <code>VerticalOffset</code>, <code>MaxWidth</code>,\n and <code>MaxHeight</code>: <ul>\n<li>\n<b>Content</b>: <code>HorizontalOffset</code> and\n <code>VerticalOffset</code> values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n <code>MaxWidth</code> and <code>MaxHeight</code>, 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.</li>\n <li>\n<b>Frame</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code>\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.</li> In addition, <code>MaxWidth</code> and\n <code>MaxHeight</code>, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.</ul></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the video preset\n values.</p>\n "
|
|
},
|
|
"Thumbnails": {
|
|
"shape_name": "Thumbnails",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </p>\n <p>You specify whether you want Elastic Transcoder to create thumbnails when you create a job.</p>\n "
|
|
},
|
|
"Interval": {
|
|
"shape_name": "Digits",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}$",
|
|
"documentation": "\n <p>The number of seconds between thumbnails. Specify an integer value.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "ThumbnailResolution",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}x\\d{1,5}$",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The width and height of thumbnail files in pixels. Specify a value in the format\n <code><i>width</i></code> x <code><i>height</i></code> where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n <code>Video:Resolution</code> object.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The aspect ratio of thumbnails. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072. </p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of thumbnails:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: 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. </li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code>\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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail <code>MaxWidth</code> and\n <code>MaxHeight</code> settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic\n Transcoder crops the thumbnails.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and <code>MaxHeight</code> settings.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the thumbnail preset\n values, if any.</p>\n "
|
|
},
|
|
"Type": {
|
|
"shape_name": "PresetType",
|
|
"type": "string",
|
|
"pattern": "(^System$)|(^Custom$)",
|
|
"documentation": "\n <p>Whether the preset is a default preset provided by Elastic Transcoder\n (<code>System</code>) or a preset that you have defined (<code>Custom</code>).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Presets are templates that contain most of the settings for transcoding media files from\n one format to another. Elastic Transcoder includes some default presets for common formats, for\n example, several iPod and iPhone versions. You can also create your own presets for\n formats that aren't included among the default presets. You specify which preset you\n want to use when you create a job.</p>\n "
|
|
},
|
|
"documentation": "\n <p>An array of <code>Preset</code> objects.</p>\n "
|
|
},
|
|
"NextPageToken": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>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 <code>NextPageToken</code> is <code>null</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ListPresetsResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the\n presets that you've added in an AWS region.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/presets HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]</request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Presets\":[ { \"Audio\":{ \"BitRate\":\"96\",\n \"Channels\":\"2\", \"Codec\":\"AAC\", \"SampleRate\":\"44100\" }, \"Container\":\"mp4\",\n \"Description\":\"Use for published videos\", \"Id\":\"5555555555555-abcde5\",\n \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\", \"Interval\":\"120\",\n \"MaxHeight\":\"auto\", \"MaxWidth\":\"auto\", \"PaddingPolicy\":\"Pad\",\n \"SizingPolicy\":\"Fit\" }, \"Type\":\"Custom\", \"Video\":{ \"BitRate\":\"1600\",\n \"Codec\":\"H.264\", \"CodecOptions\":{ \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\",\n \"Profile\":\"main\", \"MaxBitRate\":\"\", \"BufferSize\":\"\" },\n \"DisplayAspectRatio\":\"auto\", \"FixedGOP\":\"false\", \"FrameRate\":\"30\",\n \"KeyframesMaxDist\":\"240\", \"MaxHeight\":\"auto\", \"MaxWidth\":\"auto\",\n \"PaddingPolicy\":\"Pad\", \"SizingPolicy\":\"Fit\" } }, {...} ] } </response>\n </example>\n </examples>\n ",
|
|
"pagination": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Presets",
|
|
"py_input_token": "page_token"
|
|
}
|
|
},
|
|
"ReadJob": {
|
|
"name": "ReadJob",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/jobs/{Id}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ReadJobRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the job for which you want to get detailed information.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadJobRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReadJobResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Job": {
|
|
"shape_name": "Job",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
},
|
|
"PipelineId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The <code>Id</code> 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. </p>\n "
|
|
},
|
|
"Input": {
|
|
"shape_name": "JobInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> 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 <code>InputBucket</code> object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p>\n <p>If the file name includes a prefix, such as <code>cooking/lasagna.mpg</code>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify <code>auto</code>. If you want to specify the frame rate for\n the input file, enter one of the following values: </p>\n <p>\n <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>\n </p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n the frame rate.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <p>This value must be <code>auto</code>, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify <code>auto</code>. If you want to specify the aspect\n ratio for the output file, enter one of the following values: </p>\n <p>\n <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code>\n </p>\n <p> If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection\n of the aspect ratio. </p>\n "
|
|
},
|
|
"Interlaced": {
|
|
"shape_name": "Interlaced",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify <code>auto</code>. If you want to specify whether\n the input file is interlaced, enter one of the following values:</p>\n <p><code>true</code>, <code>false</code></p>\n <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of\n interlacing.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "JobContainer",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)",
|
|
"documentation": "\n <p>The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify <code>auto</code>. If you want to specify the\n container type for the input file, enter one of the following values: </p>\n <p>\n <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, \n <code>divx</code>, <code>flv</code>, <code>m4a</code>, <code>mkv</code>, \n <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, \n <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>, <code>ogg</code>, \n <code>vob</code>, <code>wav</code>, <code>webm</code>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> A section of the request or response body that provides information about the file that\n is being transcoded.</p>\n "
|
|
},
|
|
"Output": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.</p>\n <p><important>Outputs recommended instead.</important> A section of the request or response\n body that provides information about the transcoded (target) file. </p>\n "
|
|
},
|
|
"Outputs": {
|
|
"shape_name": "JobOutputs",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobOutput",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p> The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the <code>OutputBucket</code> object in the pipeline that is specified by\n the pipeline ID.</p>\n "
|
|
},
|
|
"ThumbnailPattern": {
|
|
"shape_name": "ThumbnailPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{count\\}.*$)",
|
|
"documentation": "\n <p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.</p>\n <p>If you don't want Elastic Transcoder to create thumbnails, specify \"\".</p>\n <p> If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence: </p>\n <ul>\n <li>\n <p>\n <b><code>{count}</code> (Required)</b>: If you want to create thumbnails, you\n must include <code>{count}</code> in the <code>ThumbnailPattern</code> object.\n Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence\n number (beginning with <b>00001</b>) to thumbnail file names. The number\n indicates where a given thumbnail appears in the sequence of thumbnails for a\n transcoded file. </p>\n <important>If you specify a literal value and/or <code>{resolution}</code> but you\n omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create\n the job.</important>\n </li>\n <li>\n <p>\n <b>Literal values (Optional)</b>: You can specify literal values anywhere in the\n <code>ThumbnailPattern</code> object. For example, you can include them as a\n file name prefix or as a delimiter between <code>{resolution}</code> and\n <code>{count}</code>. </p>\n </li>\n <li>\n <p>\n <b><code>{resolution}</code> (Optional)</b>: If you want Elastic Transcoder to include the\n resolution in the file name, include <code>{resolution}</code> in the\n <code>ThumbnailPattern</code> object. </p>\n </li>\n </ul>\n <p>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 <code>PresetID</code> value of\n <code>CreateJobOutput</code>. Elastic Transcoder also appends the applicable file name\n extension.</p>\n "
|
|
},
|
|
"Rotate": {
|
|
"shape_name": "Rotate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)",
|
|
"documentation": "\n <p> 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: </p>\n <p><code>auto</code>, <code>0</code>, <code>90</code>, <code>180</code>,\n <code>270</code></p>\n <p> The value <code>auto</code> generally works only if the file that you're transcoding\n contains rotation metadata.</p>\n "
|
|
},
|
|
"PresetId": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The value of the <code>Id</code> 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 <code>ListPresets</code>.</p>\n "
|
|
},
|
|
"SegmentDuration": {
|
|
"shape_name": "Float",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of one output in a job. If you specified only one output for the job,\n <code>Outputs:Status</code> is always the same as <code>Job:Status</code>. If you\n specified more than one output: <ul>\n <li>\n<code>Job:Status</code> and <code>Outputs:Status</code> for all of the outputs\n is Submitted until Elastic Transcoder starts to process the first output.</li>\n <li>When Elastic Transcoder starts to process the first output,\n <code>Outputs:Status</code> for that output and <code>Job:Status</code> both\n change to Progressing. For each output, the value of <code>Outputs:Status</code>\n remains Submitted until Elastic Transcoder starts to process the output.</li>\n <li>Job:Status remains Progressing until all of the outputs reach a terminal status,\n either Complete or Error.</li>\n <li>When all of the outputs reach a terminal status, <code>Job:Status</code> changes\n to Complete only if <code>Outputs:Status</code> for all of the outputs is\n <code>Complete</code>. If <code>Outputs:Status</code> for one or more\n outputs is <code>Error</code>, the terminal status for <code>Job:Status</code>\n is also <code>Error</code>.</li>\n </ul> The value of <code>Status</code> is one of the following: <code>Submitted</code>,\n <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or\n <code>Error</code>. </p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains <code>Status</code>.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "NullableLong",
|
|
"type": "long",
|
|
"documentation": "\n <p>Duration of the output file, in seconds.</p>\n "
|
|
},
|
|
"Width": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Specifies the width of the output file in pixels.</p>\n "
|
|
},
|
|
"Height": {
|
|
"shape_name": "NullableInteger",
|
|
"type": "integer",
|
|
"documentation": "\n <p>Height of the output file, in pixels.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "JobWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "JobWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"PresetWatermarkId": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.</p>\n "
|
|
},
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p> 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 <code>Pipeline</code>; the <code>Input Bucket</code> object in that pipeline\n identifies the bucket.</p>\n <p> If the file name includes a prefix, for example, <b>logos/128x64.png</b>, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>Preset</code> for the\n current output.</p>\n <p>Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.</p>\n "
|
|
},
|
|
"AlbumArt": {
|
|
"shape_name": "JobAlbumArt",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "MergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.</p>\n <p>\n <ul>\n <li>\n<code>Replace:</code> The specified album art will replace any existing album art.</li>\n <li>\n<code>Prepend:</code> The specified album art will be placed in front of any existing \n album art.</li>\n <li>\n<code>Append:</code> The specified album art will be placed after any existing album art.</li>\n <li>\n<code>Fallback:</code> If the original input file contains artwork, Elastic Transcoder will use that\n artwork for the output. If the original input does not contain artwork, Elastic Transcoder will use the \n specified album art file.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Artwork": {
|
|
"shape_name": "Artworks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Artwork",
|
|
"type": "structure",
|
|
"members": {
|
|
"InputKey": {
|
|
"shape_name": "WatermarkKey",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)",
|
|
"documentation": "\n <p>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 <code>PipelineId</code>; the \n <code>InputBucket</code> object in that pipeline identifies the bucket.</p>\n <p>If the file name includes a prefix, for example, <code>cooking/pie.jpg</code>,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output album art in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output album art:</p>\n <p>\n <ul>\n <li>\n<code>Fit:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without \n exceeding the other value.</li>\n <li>\n<code>Fill:</code> Elastic Transcoder scales the output art so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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. </li>\n <li>\n<code>Stretch:</code> Elastic Transcoder stretches the output art to match the values that you\n specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the relative \n proportions of the input art and the output art are different, the output art will \n be distorted.</li>\n <li>\n<code>Keep:</code> Elastic Transcoder does not scale the output art. If either dimension of the\n input art exceeds the values that you specified for <code>MaxWidth</code> and \n <code>MaxHeight</code>, Elastic Transcoder crops the output art.</li>\n <li>\n<code>ShrinkToFit:</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without exceeding either value. If you specify this option, \n Elastic Transcoder does not scale the art up.</li>\n <li>\n<code>ShrinkToFill</code> Elastic Transcoder scales the output art down so that its dimensions \n match the values that you specified for at least one of <code>MaxWidth</code> and \n <code>MaxHeight</code> without dropping below either value. If you specify this \n option, Elastic Transcoder does not scale the art up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and \n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"AlbumArtFormat": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of album art, if any. Valid formats are <code>.jpg</code> and <code>.png</code>.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.</p>\n <p>To remove artwork or leave the artwork empty, you can either set <code>Artwork</code>\n to null, or set the <code>Merge Policy</code> to \"Replace\" and use an empty\n <code>Artwork</code> array.</p>\n <p>To pass through existing artwork unchanged, set the <code>Merge Policy</code> to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty <code>Artwork</code> array.</p>\n "
|
|
},
|
|
"documentation": "\n <p>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 <code>.jpg</code> and <code>.png</code></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The album art to be associated with the output file, if any.</p>\n "
|
|
},
|
|
"Composition": {
|
|
"shape_name": "Composition",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Clip",
|
|
"type": "structure",
|
|
"members": {
|
|
"TimeSpan": {
|
|
"shape_name": "TimeSpan",
|
|
"type": "structure",
|
|
"members": {
|
|
"StartTime": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
},
|
|
"Duration": {
|
|
"shape_name": "Time",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings that determine when a clip begins and how long it lasts.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.</p>\n "
|
|
},
|
|
"documentation": "\n <p>You can create an output file that contains an excerpt from the input file. This \n excerpt, called a clip, can come from the beginning, middle, or end of the file. \n The Composition object contains settings for the clips that make up an output \n file. For the current release, you can only specify settings for a single clip \n per output file. The Composition object cannot be null.</p>\n "
|
|
},
|
|
"Captions": {
|
|
"shape_name": "Captions",
|
|
"type": "structure",
|
|
"members": {
|
|
"MergePolicy": {
|
|
"shape_name": "CaptionMergePolicy",
|
|
"type": "string",
|
|
"pattern": "(^MergeOverride$)|(^MergeRetain$)|(^Override$)",
|
|
"documentation": "\n <p>A policy that determines how Elastic Transcoder handles the existence of multiple captions.</p>\n <ul>\n <li><p><b>MergeOverride:</b> 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.</p></li>\n <li><p><b>MergeRetain:</b> 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 <guilabel>CaptionSources</guilabel> is empty,\n Elastic Transcoder omits all sidecar captions from the output files.</p></li>\n <li><p><b>Override:</b> Elastic Transcoder transcodes only the\n sidecar captions that you specify in <code>CaptionSources</code>.</p></li>\n </ul>\n <p><code>MergePolicy</code> cannot be null.</p>\n "
|
|
},
|
|
"CaptionSources": {
|
|
"shape_name": "CaptionSources",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionSource",
|
|
"type": "structure",
|
|
"members": {
|
|
"Key": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name of the sidecar caption file that you want Elastic Transcoder to include in the\n output file.</p>\n "
|
|
},
|
|
"Language": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A string that specifies the language of the caption. Specify this as one of:</p>\n <ul>\n <li><p>2-character ISO 639-1 code</p></li>\n <li><p>3-character ISO 639-2 code</p></li>\n </ul>\n <p>For more information on ISO language codes and language names, see the List of ISO \n 639-1 codes.</p>\n "
|
|
},
|
|
"TimeOffset": {
|
|
"shape_name": "TimeOffset",
|
|
"type": "string",
|
|
"pattern": "(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
"documentation": "\n <p>For clip generation or captions that do not start at the same time\n as the associated video file, the <code>TimeOffset</code> tells Elastic Transcoder how much of the video to encode\n before including captions.</p>\n <p>Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.</p>\n "
|
|
},
|
|
"Label": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The label of the caption shown in the player when choosing\n a language. We recommend that you put the caption language name here, \n in the language of the captions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A source file for the input sidecar captions used during the transcoding\n process.</p>\n "
|
|
},
|
|
"max_length": 20,
|
|
"documentation": "\n <p>Source files for the input sidecar captions used during the transcoding\n process. To omit all sidecar captions, leave <code>CaptionSources</code> blank.</p>\n "
|
|
},
|
|
"CaptionFormats": {
|
|
"shape_name": "CaptionFormats",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "CaptionFormat",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "CaptionFormatFormat",
|
|
"type": "string",
|
|
"pattern": "(^mov-text$)|(^cea-608$)|(^cea-708$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)",
|
|
"documentation": "\n <p>The format you specify determines whether Elastic Transcoder generates an\n embedded or sidecar caption for this output.</p>\n <ul>\n <li>\n<p><b>Valid Embedded Caption Formats:</b></p>\n <ul>\n <li><p><b>For MP3</b>: None</p></li>\n <li><p><b>For MP4</b>: mov-text</p></li>\n <li><p><b>For MPEG-TS</b>: None</p></li>\n <li><p><b>For ogg</b>: None</p></li>\n <li><p><b>For webm</b>: None</p></li>\n </ul>\n </li>\n <li>\n<p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder\n supports dfxp (first div element only), scc, srt, and webvtt. There are\n no container restrictions on sidecar captions. If you want ttml or smpte-tt\n compatible captions, specify dfxp as your output format.</p>\n </li>\n </ul>\n "
|
|
},
|
|
"Pattern": {
|
|
"shape_name": "CaptionFormatPattern",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^.*\\{language\\}.*$)",
|
|
"documentation": "\n <p>The prefix for caption filenames, in the form <i>description</i>-<code>{language}</code>, where:</p>\n <ul>\n <li>\n<i>description</i> is a description of the video.</li>\n <li>\n<code>{language}</code> 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.</li>\n </ul>\n <p>If you don't include <code>{language}</code> in the file name pattern, Elastic Transcoder automatically\n appends \"<code>{language}</code>\" 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.</p>\n <p>For example, suppose you're transcoding into srt format. When you enter\n \"Sydney-{language}-sunrise\", and the language of the captions is English\n (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The file format of the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
},
|
|
"max_length": 4,
|
|
"documentation": "\n <p>The array of file formats for the output captions. If you leave this value blank,\n Elastic Transcoder returns an error.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>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:</p>\n <ul>\n <li>\n<p><b>Embedded:</b> 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.</p>\n <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only),\n <code>CEA-708 (EIA-708</code>, first non-empty channel only), and <code>mov-text</code></p>\n <p>Valid outputs include: <code>mov-text</code></p>\n <p>Elastic Transcoder supports a maximum of one embedded format per output.</p>\n</li>\n <li>\n<p><b>Sidecar:</b> 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.</p>\n <p>Valid input values include: <code>dfxp</code> (first div element only),\n <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>, <code>srt</code>,\n <code>ttml</code> (first div element only), and <code>webvtt</code></p>\n <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,\n <code>srt</code>, and <code>webvtt</code>.</p>\n</li>\n </ul>\n <p> If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p>\n <p>Elastic 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.</p>\n <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To pass through\n existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>,\n and pass in a null <code>CaptionSources</code> array.</p>\n <p>For more information on embedded files, see the Subtitles Wikipedia page.</p>\n <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file\n Wikipedia pages.</p> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p><important>Outputs recommended instead.</important>If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n <code>Output</code> object lists information about the first output. This duplicates\n the information that is listed for the first output in the <code>Outputs</code>\n object.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Information about the output files. We recommend that you use the <code>Outputs</code>\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 <code>Outputs</code> and <code>Output</code> syntaxes in\n the same request. You can create a maximum of 30 outputs per job. </p>\n <p> If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.</p>\n "
|
|
},
|
|
"OutputKeyPrefix": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>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 <code>OutputKeyPrefix</code>.</p>\n "
|
|
},
|
|
"Playlists": {
|
|
"shape_name": "Playlists",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Playlist",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "Filename",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all <code>Name</code> objects must be\n unique. <b>Note</b>: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in <code>Name</code>, it will appear twice in the file name.</p>\n "
|
|
},
|
|
"Format": {
|
|
"shape_name": "PlaylistFormat",
|
|
"type": "string",
|
|
"pattern": "(^HLSv3$)",
|
|
"documentation": "\n <p>This value must currently be <code>HLSv3</code>.</p>\n "
|
|
},
|
|
"OutputKeys": {
|
|
"shape_name": "OutputKeys",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Key",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n <code>SegmentDuration</code> for all of the outputs must be the same.</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p>The status of the job with which the playlist is associated.</p>\n "
|
|
},
|
|
"StatusDetail": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>Information that further explains the status.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p> Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is <code>ts</code> (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30. </p>\n "
|
|
},
|
|
"documentation": "\n <p><important>Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code> is ts (MPEG-TS),\n <code>Playlists</code> contains information about the master playlists that you want\n Elastic Transcoder to create.</p>\n <p>We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30. </p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "JobStatus",
|
|
"type": "string",
|
|
"pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)",
|
|
"documentation": "\n <p> The status of the job: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>,\n <code>Canceled</code>, or <code>Error</code>. </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the job.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadJobResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ReadJob operation returns detailed information about a job.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/jobs/3333333333333-abcde3 HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Job\":{ \"Id\":\"3333333333333-abcde3\", \"Input\":{\n \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\", \"Resolution\":\"auto\" },\n \"Output\":{ \"Key\":\"\", \"PresetId\":\"5555555555555-abcde5\", \"Rotate\":\"0\",\n \"Status\":\"Submitted\", \"StatusDetail\":\"\", \"ThumbnailPattern\":\"{count}\" },\n \"PipelineId\":\"1111111111111-abcde1\" } }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"ReadPipeline": {
|
|
"name": "ReadPipeline",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/pipelines/{Id}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ReadPipelineRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the pipeline to read.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadPipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReadPipelineResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipeline": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the pipeline.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadPipelineResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ReadPipeline operation gets detailed information about a pipeline.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/pipelines/1111111111111-abcde1 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] </request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipeline\":{ \"Id\":\"1111111111111-abcde1\",\n \"InputBucket\":\"salesoffice.example.com-source\", \"Name\":\"Default\",\n \"Notifications\":{ \"Completed\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" }, \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Status\":\"Active\" }\n }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"ReadPreset": {
|
|
"name": "ReadPreset",
|
|
"http": {
|
|
"method": "GET",
|
|
"uri": "/2012-09-25/presets/{Id}"
|
|
},
|
|
"input": {
|
|
"shape_name": "ReadPresetRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the preset for which you want to get detailed information.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadPresetRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "ReadPresetResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Preset": {
|
|
"shape_name": "Preset",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the preset.</p>\n "
|
|
},
|
|
"Description": {
|
|
"shape_name": "Description",
|
|
"type": "string",
|
|
"min_length": 0,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>A description of the preset.</p>\n "
|
|
},
|
|
"Container": {
|
|
"shape_name": "PresetContainer",
|
|
"type": "string",
|
|
"pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)",
|
|
"documentation": "\n <p>The container type for the output file. Valid values include <code>mp3</code>,\n <code>mp4</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>\n "
|
|
},
|
|
"Audio": {
|
|
"shape_name": "AudioParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "AudioCodec",
|
|
"type": "string",
|
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
},
|
|
"SampleRate": {
|
|
"shape_name": "AudioSampleRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)",
|
|
"documentation": "\n <p>The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:</p>\n <p><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>,\n <code>48000</code>, <code>96000</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</p>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "AudioBitRate",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}$",
|
|
"documentation": "\n <p>The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.</p>\n "
|
|
},
|
|
"Channels": {
|
|
"shape_name": "AudioChannels",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "AudioCodecOptions",
|
|
"type": "structure",
|
|
"members": {
|
|
"Profile": {
|
|
"shape_name": "AudioCodecProfile",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
"documentation": "\n <p>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</p>\n <p>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
},
|
|
"Video": {
|
|
"shape_name": "VideoParameters",
|
|
"type": "structure",
|
|
"members": {
|
|
"Codec": {
|
|
"shape_name": "VideoCodec",
|
|
"type": "string",
|
|
"pattern": "(^H\\.264$)|(^vp8$)",
|
|
"documentation": "\n <p>The video codec for the output file. Valid values include <code>H.264</code> and\n <code>vp8</code>. You can only specify <code>vp8</code> when the container type is\n <code>webm</code>.</p>\n "
|
|
},
|
|
"CodecOptions": {
|
|
"shape_name": "CodecOptions",
|
|
"type": "map",
|
|
"keys": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"members": {
|
|
"shape_name": "CodecOption",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>\n <b>Profile</b>\n </p>\n <p>The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:</p>\n <ul>\n <li>\n<code>baseline</code>: The profile most commonly used for videoconferencing and for\n mobile applications.</li>\n <li>\n<code>main</code>: The profile used for standard-definition digital TV\n broadcasts.</li>\n <li>\n<code>high</code>: The profile used for high-definition digital TV broadcasts and\n for Blu-ray discs.</li>\n </ul>\n <p>\n <b>Level (H.264 Only)</b>\n </p>\n <p>The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:</p>\n <p><code>1</code>, <code>1b</code>, <code>1.1</code>, <code>1.2</code>, <code>1.3</code>,\n <code>2</code>, <code>2.1</code>, <code>2.2</code>, <code>3</code>,\n <code>3.1</code>, <code>3.2</code>, <code>4</code>, <code>4.1</code></p>\n <p>\n <b>MaxReferenceFrames (H.264 Only)</b>\n </p>\n <p>Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:</p>\n <p>\n <code>Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)</code>\n </p>\n <p>where <i>Width in pixels</i> and <i>Height in pixels</i> represent either MaxWidth and\n MaxHeight, or Resolution. <i>Maximum decoded picture buffer in macroblocks</i> depends\n on the value of the <code>Level</code> object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.) </p>\n <ul>\n <li>1 - 396</li>\n <li>1b - 396</li>\n <li>1.1 - 900</li>\n <li>1.2 - 2376</li>\n <li>1.3 - 2376</li>\n <li>2 - 2376</li>\n <li>2.1 - 4752</li>\n <li>2.2 - 8100</li>\n <li>3 - 8100</li>\n <li>3.1 - 18000</li>\n <li>3.2 - 20480</li>\n <li>4 - 32768</li>\n <li>4.1 - 32768</li>\n </ul>\n <p>\n <b>MaxBitRate</b>\n </p>\n <p>The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by <code>BufferSize</code>. 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.</p>\n <p>\n <b>BufferSize</b>\n </p>\n <p>The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n <code>MaxBitRate</code> and omit <code>BufferSize</code>, Elastic Transcoder sets\n <code>BufferSize</code> to 10 times the value of <code>MaxBitRate</code>.</p>\n "
|
|
},
|
|
"KeyframesMaxDist": {
|
|
"shape_name": "KeyframesMaxDist",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,6}$",
|
|
"documentation": "\n <p>The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.</p>\n "
|
|
},
|
|
"FixedGOP": {
|
|
"shape_name": "FixedGOP",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>Whether to use a fixed value for <code>FixedGOP</code>. Valid values are\n <code>true</code> and <code>false</code>:</p>\n <ul>\n <li>\n<code>true</code>: Elastic Transcoder uses the value of <code>KeyframesMaxDist</code> for the\n distance between key frames (the number of frames in a group of pictures, or\n GOP).</li>\n <li>\n<code>false</code>: The distance between key frames can vary.</li>\n </ul>\n "
|
|
},
|
|
"BitRate": {
|
|
"shape_name": "VideoBitRate",
|
|
"type": "string",
|
|
"pattern": "(^\\d{2,5}$)|(^auto$)",
|
|
"documentation": "\n <p>The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of <code>Level</code> and <code>Profile</code>. If you specify\n <code>auto</code>, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than <code>auto</code>, 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:</p>\n <p>\n <i>Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)</i>\n </p>\n <ul>\n <li>1 - 64 : 80</li>\n <li>1b - 128 : 160</li>\n <li>1.1 - 192 : 240</li>\n <li>1.2 - 384 : 480</li>\n <li>1.3 - 768 : 960</li>\n <li>2 - 2000 : 2500</li>\n <li>3 - 10000 : 12500</li>\n <li>3.1 - 14000 : 17500</li>\n <li>3.2 - 20000 : 25000</li>\n <li>4 - 20000 : 25000</li>\n <li>4.1 - 50000 : 62500</li>\n </ul>\n "
|
|
},
|
|
"FrameRate": {
|
|
"shape_name": "FrameRate",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>The frames per second for the video stream in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>,\n <code>25</code>, <code>29.97</code>, <code>30</code>, <code>60</code></p>\n <p>If you specify <code>auto</code>, 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:</p>\n <p>\n <code>Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)</code>\n </p>\n <p>where:</p>\n <ul>\n <li>\n<i>width in pixels</i> and <i>height in pixels</i> represent the Resolution of the\n output video.</li>\n <li>\n<i>maximum recommended decoding speed in Luma samples/second</i> 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.</li>\n </ul>\n <p>The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (<i>Level - Decoding speed</i>):</p>\n <ul>\n <li>1 - 380160</li>\n <li>1b - 380160</li>\n <li>1.1 - 76800</li>\n <li>1.2 - 1536000</li>\n <li>1.3 - 3041280</li>\n <li>2 - 3041280</li>\n <li>2.1 - 5068800</li>\n <li>2.2 - 5184000</li>\n <li>3 - 10368000</li>\n <li>3.1 - 27648000</li>\n <li>3.2 - 55296000</li>\n <li>4 - 62914560</li>\n <li>4.1 - 62914560</li>\n </ul>\n "
|
|
},
|
|
"MaxFrameRate": {
|
|
"shape_name": "MaxFrameRate",
|
|
"type": "string",
|
|
"pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)",
|
|
"documentation": "\n <p>If you specify <code>auto</code> for <code>FrameRate</code>, 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: <code>10</code>,\n <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,\n <code>29.97</code>, <code>30</code>, <code>60</code>.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "Resolution",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The width and height of the video in the output file, in pixels. Valid values are\n <code>auto</code> and <i>width</i> x <i>height</i>:</p>\n <ul>\n <li>\n<code>auto</code>: Elastic Transcoder attempts to preserve the width and height of the input file,\n subject to the following rules.</li>\n <li>\n<code><i>width</i> x <i>height</i></code>: The width and height of the output video\n in pixels.</li>\n </ul>\n <p>Note the following about specifying the width and height:</p>\n <ul>\n <li>The width must be an even integer between 128 and 4096, inclusive.</li>\n <li>The height must be an even integer between 96 and 3072, inclusive.</li>\n <li>If 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.</li>\n <li>If you specify a resolution that is greater than the resolution of the input file,\n Elastic Transcoder rescales the output to the higher resolution.</li>\n <li>We 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 (<i>List - Max\n width x height value</i>):</li>\n <ul>\n <li>1 - 25344</li>\n <li>1b - 25344</li>\n <li>1.1 - 101376</li>\n <li>1.2 - 101376</li>\n <li>1.3 - 101376</li>\n <li>2 - 101376</li>\n <li>2.1 - 202752</li>\n <li>2.2 - 404720</li>\n <li>3 - 404720</li>\n <li>3.1 - 921600</li>\n <li>3.2 - 1310720</li>\n <li>4 - 2097152</li>\n <li>4.1 - 2097152</li>\n </ul>\n </ul>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of output videos, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, <code>PaddingPolicy</code>, and\n <code>DisplayAspectRatio</code> instead of <code>Resolution</code> and\n <code>AspectRatio</code>. The two groups of settings are mutually exclusive. Do\n not use them together.</p>\n </important>\n <p>The display aspect ratio of the video in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.</p>\n <p>If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p> The maximum width of the output video in pixels. If you specify <code>auto</code>, 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. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of the output video in pixels. If you specify <code>auto</code>, 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.</p>\n "
|
|
},
|
|
"DisplayAspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <p>The value that Elastic Transcoder adds to the metadata in the output file.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of the output video:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales the output video so it matches the value that you\n specified in either <code>MaxWidth</code> or <code>MaxHeight</code> 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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches the output video to match the values that\n you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the input video and the output video are different, the\n output video will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale the output video. If either\n dimension of the input video exceeds the values that you specified for\n <code>MaxWidth</code> and <code>MaxHeight</code>, Elastic Transcoder crops the output\n video.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales the output video down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale the video up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code>\n and <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"Watermarks": {
|
|
"shape_name": "PresetWatermarks",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "PresetWatermark",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "PresetWatermarkId",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": " A unique identifier for the settings for one\n watermark. The value of <code>Id</code> can be up to 40 characters long. "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "WatermarkSizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)",
|
|
"documentation": "\n <p>A value that controls scaling of the watermark: <ul>\n <li>\n<b>Fit</b>: Elastic Transcoder scales the watermark so it matches the value that\n you specified in either <code>MaxWidth</code> or <code>MaxHeight</code> without\n exceeding the other value.</li>\n <li>\n<b>Stretch</b>: Elastic Transcoder stretches the watermark to match the values\n that you specified for <code>MaxWidth</code> and <code>MaxHeight</code>. If the\n relative proportions of the watermark and the values of <code>MaxWidth</code>\n and <code>MaxHeight</code> are different, the watermark will be distorted.</li>\n <li>\n<b>ShrinkToFit</b>: Elastic Transcoder scales the watermark down so that its\n dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding either\n value. If you specify this option, Elastic Transcoder does not scale the\n watermark up.</li>\n</ul>\n </p>\n "
|
|
},
|
|
"HorizontalAlign": {
|
|
"shape_name": "HorizontalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Left$)|(^Right$)|(^Center$)",
|
|
"documentation": "\n <p>The horizontal position of the watermark unless you specify a non-zero value for\n <code>HorizontalOffset</code>: <ul>\n <li>\n<b>Left</b>: The left edge of the watermark is aligned with the left border of\n the video.</li>\n <li>\n<b>Right</b>: The right edge of the watermark is aligned with the right border\n of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the left and right\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"HorizontalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. 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.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
},
|
|
"VerticalAlign": {
|
|
"shape_name": "VerticalAlign",
|
|
"type": "string",
|
|
"pattern": "(^Top$)|(^Bottom$)|(^Center$)",
|
|
"documentation": "\n <p>The vertical position of the watermark unless you specify a non-zero value for\n <code>VerticalOffset</code>: <ul>\n <li>\n<b>Top</b>: The top edge of the watermark is aligned with the top border of the\n video.</li>\n <li>\n<b>Bottom</b>: The bottom edge of the watermark is aligned with the bottom\n border of the video.</li>\n <li>\n<b>Center</b>: The watermark is centered between the top and bottom\n borders.</li>\n</ul></p>\n "
|
|
},
|
|
"VerticalOffset": {
|
|
"shape_name": "PixelsOrPercent",
|
|
"type": "string",
|
|
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)",
|
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> 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.</p>\n "
|
|
},
|
|
"Opacity": {
|
|
"shape_name": "Opacity",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
"documentation": "\n <p>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 <code>Opacity</code> is float.</p>\n <p>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 <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
},
|
|
"Target": {
|
|
"shape_name": "Target",
|
|
"type": "string",
|
|
"pattern": "(^Content$)|(^Frame$)",
|
|
"documentation": "\n <p>A value that determines how Elastic Transcoder interprets values that you specified for\n <code>HorizontalOffset</code>, <code>VerticalOffset</code>, <code>MaxWidth</code>,\n and <code>MaxHeight</code>: <ul>\n<li>\n<b>Content</b>: <code>HorizontalOffset</code> and\n <code>VerticalOffset</code> values are calculated based on the borders of\n the video excluding black bars added by Elastic Transcoder, if any. In addition,\n <code>MaxWidth</code> and <code>MaxHeight</code>, 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.</li>\n <li>\n<b>Frame</b>: <code>HorizontalOffset</code> and <code>VerticalOffset</code>\n values are calculated based on the borders of the video including black bars\n added by Elastic Transcoder, if any.</li> In addition, <code>MaxWidth</code> and\n <code>MaxHeight</code>, if specified as a percentage, are calculated based on\n the borders of the video including black bars added by Elastic Transcoder, if any.</ul></p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
},
|
|
"documentation": "\n <p>Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.</p>\n <p>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.</p>\n <p>When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the video preset\n values.</p>\n "
|
|
},
|
|
"Thumbnails": {
|
|
"shape_name": "Thumbnails",
|
|
"type": "structure",
|
|
"members": {
|
|
"Format": {
|
|
"shape_name": "JpgOrPng",
|
|
"type": "string",
|
|
"pattern": "(^jpg$)|(^png$)",
|
|
"documentation": "\n <p>The format of thumbnails, if any. Valid values are <code>jpg</code> and <code>png</code>. </p>\n <p>You specify whether you want Elastic Transcoder to create thumbnails when you create a job.</p>\n "
|
|
},
|
|
"Interval": {
|
|
"shape_name": "Digits",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}$",
|
|
"documentation": "\n <p>The number of seconds between thumbnails. Specify an integer value.</p>\n "
|
|
},
|
|
"Resolution": {
|
|
"shape_name": "ThumbnailResolution",
|
|
"type": "string",
|
|
"pattern": "^\\d{1,5}x\\d{1,5}$",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The width and height of thumbnail files in pixels. Specify a value in the format\n <code><i>width</i></code> x <code><i>height</i></code> where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n <code>Video:Resolution</code> object.</p>\n "
|
|
},
|
|
"AspectRatio": {
|
|
"shape_name": "AspectRatio",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)",
|
|
"documentation": "\n <important>\n <p>To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values <code>MaxWidth</code>, <code>MaxHeight</code>,\n <code>SizingPolicy</code>, and <code>PaddingPolicy</code> instead of\n <code>Resolution</code> and <code>AspectRatio</code>. The two groups of settings\n are mutually exclusive. Do not use them together.</p>\n </important>\n <p>The aspect ratio of thumbnails. Valid values include:</p>\n <p><code>auto</code>, <code>1:1</code>, <code>4:3</code>, <code>3:2</code>,\n <code>16:9</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.</p>\n "
|
|
},
|
|
"MaxWidth": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096. </p>\n "
|
|
},
|
|
"MaxHeight": {
|
|
"shape_name": "DigitsOrAuto",
|
|
"type": "string",
|
|
"pattern": "(^auto$)|(^\\d{2,4}$)",
|
|
"documentation": "\n <p>The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072. </p>\n "
|
|
},
|
|
"SizingPolicy": {
|
|
"shape_name": "SizingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)",
|
|
"documentation": "\n <p>Specify one of the following values to control scaling of thumbnails:</p>\n <p>\n <ul>\n <li>\n<code>Fit</code>: 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. </li>\n <li>\n<code>Fill</code>: Elastic Transcoder scales thumbnails so they match the value\n that you specified in thumbnail <code>MaxWidth</code> or <code>MaxHeight</code>\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.</li>\n <li>\n<code>Stretch</code>: Elastic Transcoder stretches thumbnails to match the\n values that you specified for thumbnail <code>MaxWidth</code> and\n <code>MaxHeight</code> settings. If the relative proportions of the input\n video and thumbnails are different, the thumbnails will be distorted.</li>\n <li>\n<code>Keep</code>: Elastic Transcoder does not scale thumbnails. If either\n dimension of the input video exceeds the values that you specified for thumbnail\n <code>MaxWidth</code> and <code>MaxHeight</code> settings, Elastic\n Transcoder crops the thumbnails.</li>\n <li>\n<code>ShrinkToFit</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n thumbnail <code>MaxWidth</code> and <code>MaxHeight</code> without exceeding\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n <li>\n<code>ShrinkToFill</code>: Elastic Transcoder scales thumbnails down so that\n their dimensions match the values that you specified for at least one of\n <code>MaxWidth</code> and <code>MaxHeight</code> without dropping below\n either value. If you specify this option, Elastic Transcoder does not scale\n thumbnails up.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"PaddingPolicy": {
|
|
"shape_name": "PaddingPolicy",
|
|
"type": "string",
|
|
"pattern": "(^Pad$)|(^NoPad$)",
|
|
"documentation": "\n <p>When you set <code>PaddingPolicy</code> to <code>Pad</code>, 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 <code>MaxWidth</code> and <code>MaxHeight</code> settings.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the thumbnail preset\n values, if any.</p>\n "
|
|
},
|
|
"Type": {
|
|
"shape_name": "PresetType",
|
|
"type": "string",
|
|
"pattern": "(^System$)|(^Custom$)",
|
|
"documentation": "\n <p>Whether the preset is a default preset provided by Elastic Transcoder\n (<code>System</code>) or a preset that you have defined (<code>Custom</code>).</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the preset.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ReadPresetResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The ReadPreset operation gets detailed information about a preset.</p>\n <examples>\n <example>\n <request>GET /2012-09-25/presets/5555555555555-abcde5 HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] </request>\n <response>Status: 200 OK Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] { \"Preset\":{ \"Audio\":{\n \"Codec\":\"AAC\", \"SampleRate\":\"44100\", \"BitRate\":96, \"Channels\":2 },\n \"Container\":\"mp4\", \"Description\":\"Use for published videos\",\n \"Id\":\"5555555555555-abcde5\", \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto\", \"MaxHeight\": \"auto\", \"SizingPolicy\":\n \"Fill\", \"PaddingPolicy\": \"Pad\" }, \"Type\":\"Custom\", \"Video\":{ \"MaxWidth\": \"auto\",\n \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fill\", \"PaddingPolicy\": \"Pad\",\n \"DisplayAspectRatio\": \"auto\", \"BitRate\":\"1600\", \"Codec\":\"H.264\",\n \"CodecOptions\":{ \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\", \"Profile\":\"main\",\n \"MaxBitRate\":\"\", \"BufferSize\":\"\" }, \"FixedGOP\":\"false\", \"FrameRate\":\"30\",\n \"KeyframesMaxDist\":\"240\" } } }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"TestRole": {
|
|
"name": "TestRole",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/roleTests",
|
|
"response_code": 200
|
|
},
|
|
"input": {
|
|
"shape_name": "TestRoleRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to\n test.</p>\n ",
|
|
"required": true
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read\n from this bucket.</p>\n ",
|
|
"required": true
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to\n read from this bucket.</p>\n ",
|
|
"required": true
|
|
},
|
|
"Topics": {
|
|
"shape_name": "SnsTopics",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test\n notification to.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p> The <code>TestRoleRequest</code> structure. </p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "TestRoleResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Success": {
|
|
"shape_name": "Success",
|
|
"type": "string",
|
|
"pattern": "(^true$)|(^false$)",
|
|
"documentation": "\n <p>If the operation is successful, this value is <code>true</code>; otherwise, the value is\n <code>false</code>.</p>\n "
|
|
},
|
|
"Messages": {
|
|
"shape_name": "ExceptionMessages",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n <p>If the <code>Success</code> element contains <code>false</code>, this value is an array\n of one or more error messages that were generated during the test process.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>TestRoleResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The TestRole operation tests the IAM role used to create the pipeline.</p>\n <p>The <code>TestRole</code> 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.</p>\n <examples>\n <example>\n <request>POST /2012-09-25/roleTests HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"InputBucket\":\"salesoffice.example.com-source\",\n \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Topics\":\n [\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\",\n \"arn:aws:sns:us-east-1:111222333444:ETS_Progressing\"] }</request>\n <response>Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Messages\":[ \"The role\n arn:aws:iam::123456789012:role/transcode-service does not have access to the\n bucket: salesoffice.example.com-source\", \"The role\n arn:aws:iam::123456789012:role/transcode-service does not have access to the\n topic: arn:aws:sns:us-east-1:111222333444:ETS_Errors\" ], \"Success\": \"false\"\n }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdatePipeline": {
|
|
"name": "UpdatePipeline",
|
|
"http": {
|
|
"method": "PUT",
|
|
"uri": "/2012-09-25/pipelines/{Id}",
|
|
"response_code": 200
|
|
},
|
|
"input": {
|
|
"shape_name": "UpdatePipelineRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The ID of the pipeline that you want to update.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket in which you saved the media files that you want to transcode and\n the graphics that you want to use as watermarks.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The optional <code>ContentConfig</code> 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.</p>\n <p>If you specify values for <code>ContentConfig</code>, you must also specify values for\n <code>ThumbnailConfig</code>.</p>\n <p>If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>,\n omit the <code>OutputBucket</code> object.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b> (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.</li>\n <li>\n<b>Grantee Type</b>: Specify the type of value that appears in the\n <code>Grantee</code> object: <ul>\n <li>\n<b>Canonical</b>: The value in the <code>Grantee</code> 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. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n </li>\n <li>\n<b>Email</b>: The value in the <code>Grantee</code> object is the registered\n email address of an AWS account.</li>\n <li>\n<b>Group</b>: The value in the <code>Grantee</code> object is one of the\n following predefined Amazon S3 groups: <code>AllUsers</code>,\n <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n <b>Grantee</b>: 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 </li>\n <li>\n <b>Access</b>: The permission that you want to give to the AWS user that you\n specified in <code>Grantee</code>. Permissions are granted on the files that Elastic\n Transcoder adds to the bucket, including playlists and video files. Valid values\n include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for objects\n that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for objects that\n Elastic Transcoder adds to the Amazon S3 bucket. </li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the objects that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n <li>\n <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the video files and playlists that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>ThumbnailConfig</code> 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.</p>\n <p>If you specify values for <code>ContentConfig</code>, you must also specify values for\n <code>ThumbnailConfig</code> even if you don't want to create thumbnails.</p>\n <p>If you specify values for <code>ContentConfig</code> and <code>ThumbnailConfig</code>,\n omit the <code>OutputBucket</code> object.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files.</li>\n <li>\n<b>Permissions</b> (Optional): The <code>Permissions</code> 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.</li>\n <li>\n <b>GranteeType</b>: Specify the type of value that appears in the Grantee object: <ul>\n <li>\n <b>Canonical</b>: The value in the <code>Grantee</code> object is either the\n canonical user ID for an AWS account or an origin access identity for an\n Amazon CloudFront distribution. <important>A canonical user ID is not the\n same as an AWS account number.</important>\n</li>\n <li>\n<b>Email</b>: The value in the <code>Grantee</code> object is the registered\n email address of an AWS account. </li>\n <li>\n<b>Group</b>: The value in the <code>Grantee</code> object is one of the\n following predefined Amazon S3 groups: <code>AllUsers</code>,\n <code>AuthenticatedUsers</code>, or <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n <b>Grantee</b>: 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. </li>\n <li>\n <b>Access</b>: The permission that you want to give to the AWS user that you\n specified in <code>Grantee</code>. Permissions are granted on the thumbnail files\n that Elastic Transcoder adds to the bucket. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket. </li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails\n that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions for the\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. </li>\n </ul>\n </li>\n <li>\n <b>StorageClass</b>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>UpdatePipelineRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdatePipelineResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipeline": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The pipeline (queue) that is used to manage jobs.</p>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.\n </p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceInUseException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p> Use the <code>UpdatePipeline</code> operation to update settings for a pipeline.\n <important>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. </important>\n </p>\n "
|
|
},
|
|
"UpdatePipelineNotifications": {
|
|
"name": "UpdatePipelineNotifications",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/pipelines/{Id}/notifications"
|
|
},
|
|
"input": {
|
|
"shape_name": "UpdatePipelineNotificationsRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p> The identifier of the pipeline for which you want to change notification settings. </p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job\n status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b>: 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.</li>\n <li>\n<b>Completed</b>: 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.</li>\n <li>\n<b>Warning</b>: 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.</li>\n <li>\n<b>Error</b>: 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.</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>UpdatePipelineNotificationsRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdatePipelineNotificationsResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipeline": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the pipeline.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>UpdatePipelineNotificationsResponse</code> structure.</p>\n "
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceInUseException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)\n notifications for a pipeline.</p>\n <p>When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified\n in the request.</p>\n <examples>\n <example>\n <request>POST /2012-09-25/pipelines/1111111111111-abcde1/notifications HTTP/1.1\n Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Id\":\"1111111111111-abcde1\", \"Notifications\":{\n \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" } }</request>\n <response>Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Id\":\"1111111111111-abcde1\",\n \"Notifications\":{ \"Completed\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" } }</response>\n </example>\n </examples>\n "
|
|
},
|
|
"UpdatePipelineStatus": {
|
|
"name": "UpdatePipelineStatus",
|
|
"http": {
|
|
"method": "POST",
|
|
"uri": "/2012-09-25/pipelines/{Id}/status"
|
|
},
|
|
"input": {
|
|
"shape_name": "UpdatePipelineStatusRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier of the pipeline to update.</p>\n ",
|
|
"required": true,
|
|
"location": "uri"
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The desired status of the pipeline:</p>\n <ul>\n <li>\n <code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n <code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n ",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>UpdatePipelineStatusRequest</code> structure.</p>\n "
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdatePipelineStatusResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Pipeline": {
|
|
"shape_name": "Pipeline",
|
|
"type": "structure",
|
|
"members": {
|
|
"Id": {
|
|
"shape_name": "Id",
|
|
"type": "string",
|
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
"documentation": "\n <p>The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset. </p>\n "
|
|
},
|
|
"Arn": {
|
|
"shape_name": "String",
|
|
"type": "string",
|
|
"documentation": "\n <p>The Amazon Resource Name (ARN) for the pipeline.</p>\n "
|
|
},
|
|
"Name": {
|
|
"shape_name": "Name",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 40,
|
|
"documentation": "\n <p>The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.</p>\n <p>Constraints: Maximum 40 characters</p>\n "
|
|
},
|
|
"Status": {
|
|
"shape_name": "PipelineStatus",
|
|
"type": "string",
|
|
"pattern": "(^Active$)|(^Paused$)",
|
|
"documentation": "\n <p>The current status of the pipeline:</p>\n <ul>\n <li>\n<code>Active</code>: The pipeline is processing jobs.</li>\n <li>\n<code>Paused</code>: The pipeline is not currently processing jobs.</li>\n </ul>\n "
|
|
},
|
|
"InputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.</p>\n "
|
|
},
|
|
"OutputBucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p>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 <code>ContentConfig</code> and <code>ThumbnailConfig</code>.</p>\n "
|
|
},
|
|
"Role": {
|
|
"shape_name": "Role",
|
|
"type": "string",
|
|
"pattern": "^arn:aws:iam::\\w{12}:role/.+$",
|
|
"documentation": "\n <p>The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.</p>\n "
|
|
},
|
|
"Notifications": {
|
|
"shape_name": "Notifications",
|
|
"type": "structure",
|
|
"members": {
|
|
"Progressing": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.</p>\n "
|
|
},
|
|
"Completed": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.</p>\n "
|
|
},
|
|
"Warning": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.</p>\n "
|
|
},
|
|
"Error": {
|
|
"shape_name": "SnsTopic",
|
|
"type": "string",
|
|
"pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)",
|
|
"documentation": "\n <p>The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.</p>\n <important>To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.</important>\n <ul>\n <li>\n<b>Progressing</b> (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify\n when Elastic Transcoder has started to process the job.</li>\n <li>\n<b>Completed</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has\n finished processing the job.</li>\n <li>\n<b>Warning</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters a warning condition.</li>\n <li>\n<b>Error</b> (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder\n encounters an error condition.</li>\n </ul>\n "
|
|
},
|
|
"ContentConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<b>Bucket</b>: The Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists.</li>\n <li>\n<b>Permissions</b>: 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. <ul>\n <li>GranteeType: The type of value that appears in the <code>Grantee</code>\n object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution.</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n transcoded files and playlists.</li>\n <li>\n<code>Access</code>: The permission that you want to give to the AWS user\n that is listed in <code>Grantee</code>. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the objects and metadata for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n objects that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has <code>READ</code>,\n <code>READ_ACP</code>, and <code>WRITE_ACP</code> permissions\n for the objects that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<b>StorageClass</b>: 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. </li>\n </ul>\n "
|
|
},
|
|
"ThumbnailConfig": {
|
|
"shape_name": "PipelineOutputConfig",
|
|
"type": "structure",
|
|
"members": {
|
|
"Bucket": {
|
|
"shape_name": "BucketName",
|
|
"type": "string",
|
|
"pattern": "^(\\w|\\.|-){1,255}$",
|
|
"documentation": "\n <p> 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: <ul>\n <li>You want to save transcoded files, thumbnails (if any), and playlists (if any)\n together in one bucket.</li>\n <li>You do not want to specify the users or groups who have access to the transcoded\n files, thumbnails, and playlists.</li>\n <li>You do not want to specify the permissions that Elastic Transcoder grants to the files. </li>\n <li>You want to associate the transcoded files and thumbnails with the Amazon S3\n Standard storage class.</li>\n </ul> If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for <code>ContentConfig</code> and <code>ThumbnailConfig</code> instead. </p>\n "
|
|
},
|
|
"StorageClass": {
|
|
"shape_name": "StorageClass",
|
|
"type": "string",
|
|
"pattern": "(^ReducedRedundancy$)|(^Standard$)",
|
|
"documentation": "\n <p> The Amazon S3 storage class, <code>Standard</code> or <code>ReducedRedundancy</code>,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket. </p>\n "
|
|
},
|
|
"Permissions": {
|
|
"shape_name": "Permissions",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Permission",
|
|
"type": "structure",
|
|
"members": {
|
|
"GranteeType": {
|
|
"shape_name": "GranteeType",
|
|
"type": "string",
|
|
"pattern": "(^Canonical$)|(^Email$)|(^Group$)",
|
|
"documentation": "\n <p>The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS account or an\n origin access identity for an Amazon CloudFront distribution. <important>A\n canonical user ID is not the same as an AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3 groups:\n <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </p>\n "
|
|
},
|
|
"Grantee": {
|
|
"shape_name": "Grantee",
|
|
"type": "string",
|
|
"min_length": 1,
|
|
"max_length": 255,
|
|
"documentation": "\n <p>The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.</p>\n "
|
|
},
|
|
"Access": {
|
|
"shape_name": "AccessControls",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "AccessControl",
|
|
"type": "string",
|
|
"pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)",
|
|
"documentation": null
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p> The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata for\n thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the thumbnails that\n Elastic Transcoder adds to the Amazon S3 bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and WRITE_ACP\n permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n </ul>\n </p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>The <code>Permission</code> structure.</p>\n "
|
|
},
|
|
"max_length": 30,
|
|
"documentation": "\n <p>Optional. The <code>Permissions</code> 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.</p>\n <p>If you include <code>Permissions</code>, 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 <code>Role</code>. If you want that user to have full control, you must explicitly\n grant full control to the user.</p>\n <p> If you omit <code>Permissions</code>, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by <code>Role</code>, and grants no\n other permissions to any other user or group.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both <code>ContentConfig</code> and\n <code>ThumbnailConfig</code>, or you specify <code>OutputBucket</code>.</p>\n <ul>\n <li>\n<code>Bucket</code>: The Amazon S3 bucket in which you want Elastic Transcoder to\n save thumbnail files. </li>\n <li>\n<code>Permissions</code>: 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. <ul>\n <li>GranteeType: The type of value that appears in the Grantee object: <ul>\n <li>\n<code>Canonical</code>: Either the canonical user ID for an AWS\n account or an origin access identity for an Amazon CloudFront\n distribution. <important>A canonical user ID is not the same as an\n AWS account number.</important>\n</li>\n <li>\n<code>Email</code>: The registered email address of an AWS\n account.</li>\n <li>\n<code>Group</code>: One of the following predefined Amazon S3\n groups: <code>AllUsers</code>, <code>AuthenticatedUsers</code>, or\n <code>LogDelivery</code>.</li>\n </ul>\n </li>\n <li>\n<code>Grantee</code>: The AWS user or group that you want to have access to\n thumbnail files.</li>\n <li>Access: The permission that you want to give to the AWS user that is listed\n in Grantee. Valid values include: <ul>\n <li>\n<code>READ</code>: The grantee can read the thumbnails and metadata\n for thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>READ_ACP</code>: The grantee can read the object ACL for\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>WRITE_ACP</code>: The grantee can write the ACL for the\n thumbnails that Elastic Transcoder adds to the Amazon S3\n bucket.</li>\n <li>\n<code>FULL_CONTROL</code>: The grantee has READ, READ_ACP, and\n WRITE_ACP permissions for the thumbnails that Elastic Transcoder\n adds to the Amazon S3 bucket.</li>\n </ul>\n </li>\n </ul>\n </li>\n <li>\n<code>StorageClass</code>: The Amazon S3 storage class, <code>Standard</code> or\n <code>ReducedRedundancy</code>, that you want Elastic Transcoder to assign to\n the thumbnails that it stores in your Amazon S3 bucket.</li>\n </ul>\n "
|
|
}
|
|
},
|
|
"documentation": "\n <p>A section of the response body that provides information about the pipeline.</p>\n "
|
|
}
|
|
},
|
|
"documentation": "When you update status for a pipeline,\n Elastic Transcoder returns the values that you specified in the request."
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "ValidationException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>One or more required parameter values were not provided in the request.</p>\n "
|
|
},
|
|
{
|
|
"shape_name": "IncompatibleVersionException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": null
|
|
},
|
|
{
|
|
"shape_name": "ResourceNotFoundException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "ResourceInUseException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "AccessDeniedException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p> General authentication failure. The request was not signed correctly. </p>\n "
|
|
},
|
|
{
|
|
"shape_name": "InternalServiceException",
|
|
"type": "structure",
|
|
"members": {},
|
|
"documentation": "\n <p>Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.</p>\n "
|
|
}
|
|
],
|
|
"documentation": "\n <p>The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline\n stops or restarts the processing of jobs.</p>\n <p>Changing 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 <a>CancelJob</a> request. </p>\n <examples>\n <example>\n <request>POST /2012-09-25/pipelines/1111111111111-abcde1/status HTTP/1.1\n Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Id\":\"1111111111111-abcde1\", \"Status\":\"Active\" } </request>\n <response>Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Id\":\"1111111111111-abcde1\",\n \"Status\":\"Active\" } </response>\n </example>\n </examples>\n "
|
|
}
|
|
},
|
|
"pagination": {
|
|
"ListJobsByPipeline": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Jobs",
|
|
"py_input_token": "page_token"
|
|
},
|
|
"ListJobsByStatus": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Jobs",
|
|
"py_input_token": "page_token"
|
|
},
|
|
"ListPipelines": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Pipelines",
|
|
"py_input_token": "page_token"
|
|
},
|
|
"ListPresets": {
|
|
"input_token": "PageToken",
|
|
"output_token": "NextPageToken",
|
|
"result_key": "Presets",
|
|
"py_input_token": "page_token"
|
|
}
|
|
},
|
|
"retry": {
|
|
"__default__": {
|
|
"max_attempts": 5,
|
|
"delay": {
|
|
"type": "exponential",
|
|
"base": "rand",
|
|
"growth_factor": 2
|
|
},
|
|
"policies": {
|
|
"general_socket_errors": {
|
|
"applies_when": {
|
|
"socket_errors": [
|
|
"GENERAL_CONNECTION_ERROR"
|
|
]
|
|
}
|
|
},
|
|
"general_server_error": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 500
|
|
}
|
|
}
|
|
},
|
|
"service_unavailable": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 503
|
|
}
|
|
}
|
|
},
|
|
"limit_exceeded": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 509
|
|
}
|
|
}
|
|
},
|
|
"throttling": {
|
|
"applies_when": {
|
|
"response": {
|
|
"service_error_code": "ThrottlingException",
|
|
"http_status_code": 400
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |