AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessDeniedException | ElasticTranscoder exception | |
Artwork |
The file to be used as album art. There can be multiple artworks associated with an
audio file, to a maximum of 20.
To remove artwork or leave the artwork empty, you can either set
To pass through existing artwork unchanged, set the |
|
AudioCodecOptions | Options associated with your audio codec. | |
AudioParameters | Parameters required for transcoding audio. | |
CancelJobRequest |
Container for the parameters to the CancelJob operation.
The CancelJob operation cancels an unfinished job.
Submitted . To prevent
a pipeline from starting to process a job while you're getting the job identifier,
use UpdatePipelineStatus to temporarily pause the pipeline. |
|
CancelJobResponse | Configuration for accessing Amazon CancelJob service | |
CancelJobResult |
The response body contains a JSON object. If the job is successfully canceled, the
value of Success is true .
|
|
CaptionFormat | The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error. | |
Captions | The captions to be created, if any. | |
CaptionSource | A source file for the input sidecar captions used during the transcoding process. | |
Clip | Settings for one clip in a composition. All jobs in a playlist must have the same clip settings. | |
CreateJobOutput |
The CreateJobOutput structure.
|
|
CreateJobPlaylist | Information about the master playlist. | |
CreateJobRequest |
Container for the parameters to the CreateJob operation.
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.
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). |
|
CreateJobResponse | Configuration for accessing Amazon CreateJob service | |
CreateJobResult | The CreateJobResponse structure. | |
CreatePipelineRequest | Container for the parameters to the CreatePipeline operation. The CreatePipeline operation creates a pipeline with settings that you specify. | |
CreatePipelineResponse | Configuration for accessing Amazon CreatePipeline service | |
CreatePipelineResult | When you create a pipeline, Elastic Transcoder returns the values that you specified in the request. | |
CreatePresetRequest |
Container for the parameters to the CreatePreset operation.
The CreatePreset operation creates a preset with settings that you specify.
ValidationException ) and does not create
the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant
with the H.264 standard, Elastic Transcoder creates the preset and returns a warning
message in the response. This helps you determine whether your settings comply with
the H.264 standard while giving you greater flexibility with respect to the video
that Elastic Transcoder produces.Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services. |
|
CreatePresetResponse | Configuration for accessing Amazon CreatePreset service | |
CreatePresetResult |
The CreatePresetResponse structure.
|
|
DeletePipelineRequest |
Container for the parameters to the DeletePipeline operation.
The DeletePipeline operation removes a pipeline.
You can only delete a pipeline that has never been used or that is not currently
in use (doesn't contain any active jobs). If the pipeline is currently in use, |
|
DeletePipelineResponse | Configuration for accessing Amazon DeletePipeline service | |
DeletePipelineResult |
The DeletePipelineResponse structure.
|
|
DeletePresetRequest |
Container for the parameters to the DeletePreset operation.
The DeletePreset operation removes a preset that you've added in an AWS region.
You can't delete the default presets that are included with Elastic Transcoder. |
|
DeletePresetResponse | Configuration for accessing Amazon DeletePreset service | |
DeletePresetResult |
The DeletePresetResponse structure.
|
|
DetectedProperties | The detected properties of the input file. Elastic Transcoder identifies these values from the input file. | |
Encryption | The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder will use to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files. | |
HlsContentProtection | The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files. | |
IncompatibleVersionException | ElasticTranscoder exception | |
InternalServiceException | ElasticTranscoder exception | |
Job | A section of the response body that provides information about the job that is created. | |
JobAlbumArt | The .jpg or .png file associated with an audio file. | |
JobInput | Information about the file that you're transcoding. | |
JobOutput |
Output object lists information about the first output. This duplicates
the information that is listed for the first output in the Outputs object.
|
|
JobWatermark | Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. | |
LimitExceededException | ElasticTranscoder exception | |
ListJobsByPipelineRequest |
Container for the parameters to the ListJobsByPipeline operation.
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria. |
|
ListJobsByPipelineResponse | Configuration for accessing Amazon ListJobsByPipeline service | |
ListJobsByPipelineResult |
The ListJobsByPipelineResponse structure.
|
|
ListJobsByStatusRequest | Container for the parameters to the ListJobsByStatus operation. The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria. | |
ListJobsByStatusResponse | Configuration for accessing Amazon ListJobsByStatus service | |
ListJobsByStatusResult |
The ListJobsByStatusResponse structure.
|
|
ListPipelinesRequest | Container for the parameters to the ListPipelines operation. The ListPipelines operation gets a list of the pipelines associated with the current AWS account. | |
ListPipelinesResponse | Configuration for accessing Amazon ListPipelines service | |
ListPipelinesResult | A list of the pipelines associated with the current AWS account. | |
ListPresetsRequest | Container for the parameters to the ListPresets operation. The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region. | |
ListPresetsResponse | Configuration for accessing Amazon ListPresets service | |
ListPresetsResult |
The ListPresetsResponse structure.
|
|
Notifications |
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order
to report job status.
|
|
Permission |
The Permission structure.
|
|
Pipeline | The pipeline (queue) that is used to manage jobs. | |
PipelineOutputConfig |
The PipelineOutputConfig structure.
|
|
Playlist |
Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which
the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want Elastic Transcoder
to create. We recommend that you create only one master playlist per output format.
The maximum number of master playlists in a job is 30.
|
|
PlayReadyDrm |
The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the
output files associated with this playlist.
PlayReady DRM encrypts your media files using
If you use DRM for an |
|
Preset | Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job. | |
PresetWatermark |
Settings for the size, location, and opacity of graphics that you want Elastic Transcoder
to overlay over videos that are transcoded using this preset. You can specify settings
for up to four watermarks. Watermarks appear in the specified size and location, and
with the specified opacity for the duration of the transcoded video.
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency. When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions. |
|
ReadJobRequest | Container for the parameters to the ReadJob operation. The ReadJob operation returns detailed information about a job. | |
ReadJobResponse | Configuration for accessing Amazon ReadJob service | |
ReadJobResult |
The ReadJobResponse structure.
|
|
ReadPipelineRequest | Container for the parameters to the ReadPipeline operation. The ReadPipeline operation gets detailed information about a pipeline. | |
ReadPipelineResponse | Configuration for accessing Amazon ReadPipeline service | |
ReadPipelineResult |
The ReadPipelineResponse structure.
|
|
ReadPresetRequest | Container for the parameters to the ReadPreset operation. The ReadPreset operation gets detailed information about a preset. | |
ReadPresetResponse | Configuration for accessing Amazon ReadPreset service | |
ReadPresetResult |
The ReadPresetResponse structure.
|
|
ResourceInUseException | ElasticTranscoder exception | |
ResourceNotFoundException | ElasticTranscoder exception | |
TestRoleRequest |
Container for the parameters to the TestRole operation.
The TestRole operation tests the IAM role used to create the pipeline.
The |
|
TestRoleResponse | Configuration for accessing Amazon TestRole service | |
TestRoleResult |
The TestRoleResponse structure.
|
|
Thumbnails | Thumbnails for videos. | |
TimeSpan | Settings that determine when a clip begins and how long it lasts. | |
Timing | Details about the timing of a job. | |
UpdatePipelineNotificationsRequest |
Container for the parameters to the UpdatePipelineNotifications operation.
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification
Service (Amazon SNS) notifications for a pipeline.
When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request. |
|
UpdatePipelineNotificationsResponse | Configuration for accessing Amazon UpdatePipelineNotifications service | |
UpdatePipelineNotificationsResult |
The UpdatePipelineNotificationsResponse structure.
|
|
UpdatePipelineRequest |
Container for the parameters to the UpdatePipeline operation.
Use the UpdatePipeline operation to update settings for a pipeline.
|
|
UpdatePipelineResponse | Configuration for accessing Amazon UpdatePipeline service | |
UpdatePipelineResult | When you update a pipeline, Elastic Transcoder returns the values that you specified in the request. | |
UpdatePipelineStatusRequest |
Container for the parameters to the UpdatePipelineStatus operation.
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline
stops or restarts the processing of jobs.
Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request. |
|
UpdatePipelineStatusResponse | Configuration for accessing Amazon UpdatePipelineStatus service | |
UpdatePipelineStatusResult | When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request. | |
ValidationException | ElasticTranscoder exception | |
VideoParameters |
The VideoParameters structure.
|
|
Warning |
Elastic Transcoder returns a warning if the resources used by your pipeline are not
in the same region as the pipeline.
Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges. |