openapi: 3.0.0
info:
version: 2012-09-25
x-release: v4
title: Amazon Elastic Transcoder
description: <fullname>AWS Elastic Transcoder Service</fullname> <p>The AWS Elastic Transcoder Service.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: elastictranscoder
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/elastictranscoder-2012-09-25.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/elastictranscoder/
servers:
- url: http://elastictranscoder.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Elastic Transcoder multi-region endpoint
- url: https://elastictranscoder.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Elastic Transcoder multi-region endpoint
- url: http://elastictranscoder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Elastic Transcoder endpoint for China (Beijing) and China (Ningxia)
- url: https://elastictranscoder.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Elastic Transcoder endpoint for China (Beijing) and China (Ningxia)
paths:
"/2012-09-25/jobs/{Id}":
delete:
operationId: CancelJob
description: <p>The CancelJob operation cancels an unfinished job.</p> <note> <p>You can only cancel a job that has a status of <code>Submitted</code>. To prevent a pipeline from starting to
process a job while you're getting the job identifier, use <a>UpdatePipelineStatus</a> to temporarily pause the pipeline.</p> </note>
responses:
"202":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CancelJobResponse"
examples:
CancelJob202Example:
summary: Default CancelJob 202 response
x-microcks-default: true
value: {}
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
examples:
CancelJob480Example:
summary: Default CancelJob 480 response
x-microcks-default: true
value: {}
"481":
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: "#/components/schemas/IncompatibleVersionException"
examples:
CancelJob481Example:
summary: Default CancelJob 481 response
x-microcks-default: true
value: {}
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
CancelJob482Example:
summary: Default CancelJob 482 response
x-microcks-default: true
value: {}
"483":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
examples:
CancelJob483Example:
summary: Default CancelJob 483 response
x-microcks-default: true
value: {}
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
CancelJob484Example:
summary: Default CancelJob 484 response
x-microcks-default: true
value: {}
"485":
description: InternalServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServiceException"
examples:
CancelJob485Example:
summary: Default CancelJob 485 response
x-microcks-default: true
value: {}
parameters:
- name: Id
in: path
required: true
description: <p>The identifier of the job that you want to cancel.</p> <p>To get a list of the jobs (including their <code>jobId</code>) that have a status of <code>Submitted</code>, use the
<a>ListJobsByStatus</a> API action.</p>
schema:
type: string
pattern: ^\d{13}-\w{6}$
summary: Amazon Elastic Transcoder CancelJob
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ReadJob
description: The ReadJob operation returns detailed information about a job.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ReadJobResponse"
examples:
ReadJob200Example:
summary: Default ReadJob 200 response
x-microcks-default: true
value:
Job: example
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
examples:
ReadJob480Example:
summary: Default ReadJob 480 response
x-microcks-default: true
value: {}
"481":
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: "#/components/schemas/IncompatibleVersionException"
examples:
ReadJob481Example:
summary: Default ReadJob 481 response
x-microcks-default: true
value: {}
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ReadJob482Example:
summary: Default ReadJob 482 response
x-microcks-default: true
value: {}
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
ReadJob483Example:
summary: Default ReadJob 483 response
x-microcks-default: true
value: {}
"484":
description: InternalServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServiceException"
examples:
ReadJob484Example:
summary: Default ReadJob 484 response
x-microcks-default: true
value: {}
parameters:
- name: Id
in: path
required: true
description: The identifier of the job for which you want to get detailed information.
schema:
type: string
pattern: ^\d{13}-\w{6}$
summary: Amazon Elastic Transcoder ReadJob
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/2012-09-25/jobs:
post:
operationId: CreateJob
description: <p>When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.</p> <p>If you have
specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list
the jobs (as opposed to the AWS Console).</p>
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateJobResponse"
examples:
CreateJob201Example:
summary: Default CreateJob 201 response
x-microcks-default: true
value:
Job: example
"480":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
examples:
CreateJob480Example:
summary: Default CreateJob 480 response
x-microcks-default: true
value: {}
"481":
description: IncompatibleVersionException
content:
application/json:
schema:
$ref: "#/components/schemas/IncompatibleVersionException"
examples:
CreateJob481Example:
summary: Default CreateJob 481 response
x-microcks-default: true
value: {}
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
CreateJob482Example:
summary: Default CreateJob 482 response
x-microcks-default: true
value: {}
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
examples:
CreateJob483Example:
summary: Default CreateJob 483 response
x-microcks-default: true
value: {}
"484":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
examples:
CreateJob484Example:
summary: Default CreateJob 484 response
x-microcks-default: true
value: {}
"485":
description: InternalServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServiceException"
examples:
CreateJob485Example:
summary: Default CreateJob 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- PipelineId
properties:
PipelineId:
description: The <code>Id</code> of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket
from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
type: string
pattern: ^\d{13}-\w{6}$
Input:
description: Information about the file that you're transcoding.
type: object
properties:
Key:
allOf:
- $ref: "#/components/schemas/LongKey"
- description: <p> The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The
<code>InputBucket</code> object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from. </p> <p>If the file name includes a prefix, such as
<code>cooking/lasagna.mpg</code>, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.</p>
FrameRate:
allOf:
- $ref: "#/components/schemas/FrameRate"
- description: "<p>The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify <code>auto</code>. If you want
to specify the frame rate for the input file, enter one of the following values: </p> <p> <code>10</code>, <code>15</code>, <code>23.97</code>, <code>24</code>, <code>25</code>,
<code>29.97</code>, <code>30</code>, <code>60</code> </p> <p>If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the frame rate.</p>"
Resolution:
allOf:
- $ref: "#/components/schemas/Resolution"
- description: This value must be <code>auto</code>, which causes Elastic Transcoder to automatically detect the resolution of the input file.
AspectRatio:
allOf:
- $ref: "#/components/schemas/AspectRatio"
- description: "<p> The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify <code>auto</code>. If you
want to specify the aspect ratio for the output file, enter one of the following values: </p> <p> <code>1:1</code>, <code>4:3</code>, <code>3:2</code>, <code>16:9</code> </p> <p>
If you specify a value other than <code>auto</code>, Elastic Transcoder disables automatic detection of the aspect ratio. </p>"
Interlaced:
allOf:
- $ref: "#/components/schemas/Interlaced"
- description: <p>Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify <code>auto</code>. If
you want to specify whether the input file is interlaced, enter one of the following values:</p> <p> <code>true</code>, <code>false</code> </p> <p>If you specify a value
other than <code>auto</code>, Elastic Transcoder disables automatic detection of interlacing.</p>
Container:
allOf:
- $ref: "#/components/schemas/JobContainer"
- description: "<p>The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify <code>auto</code>. If
you want to specify the container type for the input file, enter one of the following values: </p> <p> <code>3gp</code>, <code>aac</code>, <code>asf</code>, <code>avi</code>, <code>divx</code>,
<code>flv</code>, <code>m4a</code>, <code>mkv</code>, <code>mov</code>, <code>mp3</code>, <code>mp4</code>, <code>mpeg</code>, <code>mpeg-ps</code>, <code>mpeg-ts</code>, <code>mxf</code>,
<code>ogg</code>, <code>vob</code>, <code>wav</code>, <code>webm</code> </p>"
Encryption:
allOf:
- $ref: "#/components/schemas/Encryption"
- description: The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder
uses to decrypt your file.
TimeSpan:
allOf:
- $ref: "#/components/schemas/TimeSpan"
- description: Settings for clipping an input. Each input can have different clip settings.
InputCaptions:
allOf:
- $ref: "#/components/schemas/InputCaptions"
- description: "<p>You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports
two types of captions:</p> <ul> <li> <p> <b>Embedded:</b> Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded
caption per language, to a maximum of 300 embedded captions per file.</p> <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only), <code>CEA-708
(EIA-708</code>, first non-empty channel only), and <code>mov-text</code> </p> <p>Valid outputs include: <code>mov-text</code> </p> <p>Elastic Transcoder supports a maximum of
one embedded format per output.</p> </li> <li> <p> <b>Sidecar:</b> Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require
a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a
maximum of 20 sidecar captions per file.</p> <p>Valid input values include: <code>dfxp</code> (first div element only), <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>,
<code>srt</code>, <code>ttml</code> (first div element only), and <code>webvtt</code> </p> <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,
<code>srt</code>, and <code>webvtt</code>.</p> </li> </ul> <p>If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p> <p>Elastic Transcoder does
not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does
not preserve text formatting (for example, italics) during the transcoding process.</p> <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To
pass through existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>, and pass in a null <code>CaptionSources</code> array.</p> <p>For more information
on embedded files, see the Subtitles Wikipedia page.</p> <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.</p>"
DetectedProperties:
allOf:
- $ref: "#/components/schemas/DetectedProperties"
- description: The detected properties of the input file.
Inputs:
description: A section of the request body that provides information about the files that are being transcoded.
type: array
items:
$ref: "#/components/schemas/JobInput"
maxItems: 200
Output:
description: The <code>CreateJobOutput</code> structure.
type: object
properties:
Key:
allOf:
- $ref: "#/components/schemas/Key"
- description: " The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the <code>OutputBucket</code> object in the pipeline
that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails. "
ThumbnailPattern:
allOf:
- $ref: "#/components/schemas/ThumbnailPattern"
- description: "<p>Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.</p> <p>If you don't want
Elastic Transcoder to create thumbnails, specify \"\".</p> <p>If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file
name for each thumbnail. You can specify the following values in any sequence:</p> <ul> <li> <p> <b> <code>{count}</code> (Required)</b>: If you want to create thumbnails, you
must include <code>{count}</code> in the <code>ThumbnailPattern</code> object. Wherever you specify <code>{count}</code>, Elastic Transcoder adds a five-digit sequence number (beginning
with <b>00001</b>) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. </p> <important> <p>If you
specify a literal value and/or <code>{resolution}</code> but you omit <code>{count}</code>, Elastic Transcoder returns a validation error and does not create the job.</p> </important>
</li> <li> <p> <b>Literal values (Optional)</b>: You can specify literal values anywhere in the <code>ThumbnailPattern</code> object. For example, you can include them as a file
name prefix or as a delimiter between <code>{resolution}</code> and <code>{count}</code>. </p> </li> <li> <p> <b> <code>{resolution}</code> (Optional)</b>: If you want Elastic
Transcoder to include the resolution in the file name, include <code>{resolution}</code> in the <code>ThumbnailPattern</code> object. </p> </li> </ul> <p>When creating thumbnails,
Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the <code>PresetID</code> value of <code>CreateJobOutput</code>.
Elastic Transcoder also appends the applicable file name extension.</p>"
ThumbnailEncryption:
allOf:
- $ref: "#/components/schemas/Encryption"
- description: The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
Rotate:
allOf:
- $ref: "#/components/schemas/Rotate"
- description: " The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: <code>auto</code>,
<code>0</code>, <code>90</code>, <code>180</code>, <code>270</code>. The value <code>auto</code> generally works only if the file that you're transcoding contains rotation metadata. "
PresetId:
allOf:
- $ref: "#/components/schemas/Id"
- description: " The <code>Id</code> of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. "
SegmentDuration:
allOf:
- $ref: "#/components/schemas/FloatString"
- description: <important> <p>(Outputs in Fragmented MP4 or MPEG-TS format only.</p> </important> <p>If you specify a preset in <code>PresetId</code> for which the value of
<code>Container</code> is <code>fmp4</code> (Fragmented MP4) or <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the target maximum duration of each segment in
seconds. For <code>HLSv3</code> format playlists, each media segment is stored in a separate <code>.ts</code> file. For <code>HLSv4</code> and <code>Smooth</code> playlists,
all media segments for an output are stored in a single file. Each segment is approximately the length of the <code>SegmentDuration</code>, though individual segments might
be shorter or longer.</p> <p>The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by <code>SegmentDuration</code>, the duration
of the last segment is the remainder of total length/SegmentDuration.</p> <p>Elastic Transcoder creates an output-specific playlist for each output <code>HLS</code> output
that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the <code>OutputKeys</code> of the associated playlist.</p>
Watermarks:
allOf:
- $ref: "#/components/schemas/JobWatermarks"
- description: Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output.
Settings for each watermark must be defined in the preset for the current output.
AlbumArt:
allOf:
- $ref: "#/components/schemas/JobAlbumArt"
- description: Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each
output. Settings for each artwork must be defined in the job for the current output.
Composition:
allOf:
- $ref: "#/components/schemas/Composition"
- deprecated: true
description: You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file.
The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file.
The Composition object cannot be null.
Captions:
allOf:
- $ref: "#/components/schemas/Captions"
- description: "<p>You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports
two types of captions:</p> <ul> <li> <p> <b>Embedded:</b> Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded
caption per language, to a maximum of 300 embedded captions per file.</p> <p>Valid input values include: <code>CEA-608 (EIA-608</code>, first non-empty channel only), <code>CEA-708
(EIA-708</code>, first non-empty channel only), and <code>mov-text</code> </p> <p>Valid outputs include: <code>mov-text</code> </p> <p>Elastic Transcoder supports a maximum of
one embedded format per output.</p> </li> <li> <p> <b>Sidecar:</b> Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require
a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a
maximum of 20 sidecar captions per file.</p> <p>Valid input values include: <code>dfxp</code> (first div element only), <code>ebu-tt</code>, <code>scc</code>, <code>smpt</code>,
<code>srt</code>, <code>ttml</code> (first div element only), and <code>webvtt</code> </p> <p>Valid outputs include: <code>dfxp</code> (first div element only), <code>scc</code>,
<code>srt</code>, and <code>webvtt</code>.</p> </li> </ul> <p>If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p> <p>Elastic Transcoder does
not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does
not preserve text formatting (for example, italics) during the transcoding process.</p> <p>To remove captions or leave the captions empty, set <code>Captions</code> to null. To
pass through existing captions unchanged, set the <code>MergePolicy</code> to <code>MergeRetain</code>, and pass in a null <code>CaptionSources</code> array.</p> <p>For more information
on embedded files, see the Subtitles Wikipedia page.</p> <p>For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.</p>"
Encryption:
allOf:
- $ref: "#/components/schemas/Encryption"
- description: You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails,
album art, or captions that you want to use. You must specify encryption settings for each file individually.
Outputs:
description: " A section of the request body that provides information about the transcoded (target) files. We recommend that you use the <code>Outputs</code> syntax instead of the <code>Output</code>
syntax. "
type: array
items:
$ref: "#/components/schemas/CreateJobOutput"
# --- truncated at 32 KB (334 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-elastic-transcoder/refs/heads/main/openapi/amazon-elastic-transcoder-openapi.yml