SDK for PHP 3.x
Amazon Elastic Transcoder 2012-09-25
- Client: Aws\ElasticTranscoder\ElasticTranscoderClient
- Service ID: elastictranscoder
- Version: 2012-09-25
This page describes the parameters and results for the operations of the Amazon Elastic Transcoder (2012-09-25), and shows how to use the Aws\ElasticTranscoder\ElasticTranscoderClient object to call the described operations. This documentation is specific to the 2012-09-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CancelJob ( array $params = [] )
- The CancelJob operation cancels an unfinished job.
- CreateJob ( array $params = [] )
- 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.
- CreatePipeline ( array $params = [] )
- The CreatePipeline operation creates a pipeline with settings that you specify.
- CreatePreset ( array $params = [] )
- The CreatePreset operation creates a preset with settings that you specify.
- DeletePipeline ( array $params = [] )
- The DeletePipeline operation removes a pipeline.
- DeletePreset ( array $params = [] )
- The DeletePreset operation removes a preset that you've added in an AWS region.
- ListJobsByPipeline ( array $params = [] )
- The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
- ListJobsByStatus ( array $params = [] )
- The ListJobsByStatus operation gets a list of jobs that have a specified status.
- ListPipelines ( array $params = [] )
- The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
- ListPresets ( array $params = [] )
- 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.
- ReadJob ( array $params = [] )
- The ReadJob operation returns detailed information about a job.
- ReadPipeline ( array $params = [] )
- The ReadPipeline operation gets detailed information about a pipeline.
- ReadPreset ( array $params = [] )
- The ReadPreset operation gets detailed information about a preset.
- TestRole ( array $params = [] )
- The TestRole operation tests the IAM role used to create the pipeline.
- UpdatePipeline ( array $params = [] )
- Use the UpdatePipeline operation to update settings for a pipeline.
- UpdatePipelineNotifications ( array $params = [] )
- With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
- UpdatePipelineStatus ( array $params = [] )
- The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
| Waiter name | API Operation | Delay | Max Attempts |
|---|---|---|---|
| JobComplete | ReadJob | 30 | 120 |
Operations
CancelJob
$result = $client->cancelJob([/* ... */]); $promise = $client->cancelJobAsync([/* ... */]);
The CancelJob operation cancels an unfinished job.
You can only cancel a job that has a status of 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.
Parameter Syntax
$result = $client->cancelJob([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the job that you want to cancel.
To get a list of the jobs (including their
jobId) that have a status ofSubmitted, use the ListJobsByStatus API action.
Result Syntax
[]
Result Details
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- ResourceInUseException:
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
CreateJob
$result = $client->createJob([/* ... */]); $promise = $client->createJobAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->createJob([
'Input' => [
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
'Inputs' => [
[
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Output' => [
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
],
'OutputKeyPrefix' => '<string>',
'Outputs' => [
[
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
],
// ...
],
'PipelineId' => '<string>', // REQUIRED
'Playlists' => [
[
'Format' => '<string>',
'HlsContentProtection' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'KeyStoragePolicy' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
'Method' => '<string>',
],
'Name' => '<string>',
'OutputKeys' => ['<string>', ...],
'PlayReadyDrm' => [
'Format' => '<string>',
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyId' => '<string>',
'KeyMd5' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
],
],
// ...
],
'UserMetadata' => ['<string>', ...],
]);
Parameter Details
Members
- Input
-
- Type: JobInput structure
A section of the request body that provides information about the file that is being transcoded.
- Inputs
-
- Type: Array of JobInput structures
A section of the request body that provides information about the files that are being transcoded.
- Output
-
- Type: CreateJobOutput structure
A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the
Outputssyntax instead of theOutputsyntax. - OutputKeyPrefix
-
- Type: string
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.
- Outputs
-
- Type: Array of CreateJobOutput structures
A section of the request body that provides information about the transcoded (target) files. We recommend that you use the
Outputssyntax instead of theOutputsyntax. - PipelineId
-
- Required: Yes
- Type: string
The
Idof 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. - Playlists
-
- Type: Array of CreateJobPlaylist structures
If you specify a preset in
PresetIdfor which the value ofContaineris fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
- UserMetadata
-
- Type: Associative array of custom strings keys (String) to strings
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
key/valuepairs, and you can add up to 10key/valuepairs per job. Elastic Transcoder does not guarantee thatkey/valuepairs are returned in the same order in which you specify them.
Result Syntax
[
'Job' => [
'Arn' => '<string>',
'Id' => '<string>',
'Input' => [
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
'Inputs' => [
[
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Output' => [
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
'OutputKeyPrefix' => '<string>',
'Outputs' => [
[
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
// ...
],
'PipelineId' => '<string>',
'Playlists' => [
[
'Format' => '<string>',
'HlsContentProtection' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'KeyStoragePolicy' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
'Method' => '<string>',
],
'Name' => '<string>',
'OutputKeys' => ['<string>', ...],
'PlayReadyDrm' => [
'Format' => '<string>',
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyId' => '<string>',
'KeyMd5' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
],
'Status' => '<string>',
'StatusDetail' => '<string>',
],
// ...
],
'Status' => '<string>',
'Timing' => [
'FinishTimeMillis' => <integer>,
'StartTimeMillis' => <integer>,
'SubmitTimeMillis' => <integer>,
],
'UserMetadata' => ['<string>', ...],
],
]
Result Details
Members
- Job
-
- Type: Job structure
A section of the response body that provides information about the job that is created.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- LimitExceededException:
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
CreatePipeline
$result = $client->createPipeline([/* ... */]); $promise = $client->createPipelineAsync([/* ... */]);
The CreatePipeline operation creates a pipeline with settings that you specify.
Parameter Syntax
$result = $client->createPipeline([
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'InputBucket' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>', // REQUIRED
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
]);
Parameter Details
Members
- AwsKmsKeyArn
-
- Type: string
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either
s3ors3-aws-kmsas yourEncryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using anEncryption:Modeofaes-cbc-pkcs7,aes-ctr, oraes-gcm. - ContentConfig
-
- Type: PipelineOutputConfig structure
The optional
ContentConfigobject specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig, you must also specify values forThumbnailConfig.If you specify values for
ContentConfigandThumbnailConfig, omit theOutputBucketobject.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
-
Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
-
Grantee Type: Specify the type of value that appears in the
Granteeobject:-
Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Granteeobject is the registered email address of an AWS account. -
Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:-
READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee hasREAD,READ_ACP, andWRITE_ACPpermissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
- InputBucket
-
- Required: Yes
- Type: string
The Amazon S3 bucket in which you saved the media files that you want to transcode.
- Name
-
- Required: Yes
- Type: string
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters.
- Notifications
-
- Type: Notifications structure
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
-
Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
-
Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- OutputBucket
-
- Type: string
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
-
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
-
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
-
You do not want to specify the permissions that Elastic Transcoder grants to the files.
When Elastic Transcoder saves files in
OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified byRole. -
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit
OutputBucketand specify values forContentConfigandThumbnailConfiginstead. - Role
-
- Required: Yes
- Type: string
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
- ThumbnailConfig
-
- Type: PipelineOutputConfig structure
The
ThumbnailConfigobject specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig, you must also specify values forThumbnailConfigeven if you don't want to create thumbnails.If you specify values for
ContentConfigandThumbnailConfig, omit theOutputBucketobject.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
-
Permissions (Optional): The
Permissionsobject specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. -
GranteeType: Specify the type of value that appears in the Grantee object:
-
Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Granteeobject is the registered email address of an AWS account. -
Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:-
READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee hasREAD,READ_ACP, andWRITE_ACPpermissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
Result Syntax
[
'Pipeline' => [
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
'Warnings' => [
[
'Code' => '<string>',
'Message' => '<string>',
],
// ...
],
]
Result Details
Members
- Pipeline
-
- Type: Pipeline structure
A section of the response body that provides information about the pipeline that is created.
- Warnings
-
- Type: Array of Warning structures
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.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- LimitExceededException:
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
CreatePreset
$result = $client->createPreset([/* ... */]); $promise = $client->createPresetAsync([/* ... */]);
The CreatePreset operation creates a preset with settings that you specify.
Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (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.
Parameter Syntax
$result = $client->createPreset([
'Audio' => [
'AudioPackingMode' => '<string>',
'BitRate' => '<string>',
'Channels' => '<string>',
'Codec' => '<string>',
'CodecOptions' => [
'BitDepth' => '<string>',
'BitOrder' => '<string>',
'Profile' => '<string>',
'Signed' => '<string>',
],
'SampleRate' => '<string>',
],
'Container' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'Thumbnails' => [
'AspectRatio' => '<string>',
'Format' => '<string>',
'Interval' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
],
'Video' => [
'AspectRatio' => '<string>',
'BitRate' => '<string>',
'Codec' => '<string>',
'CodecOptions' => ['<string>', ...],
'DisplayAspectRatio' => '<string>',
'FixedGOP' => '<string>',
'FrameRate' => '<string>',
'KeyframesMaxDist' => '<string>',
'MaxFrameRate' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
'Watermarks' => [
[
'HorizontalAlign' => '<string>',
'HorizontalOffset' => '<string>',
'Id' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'Opacity' => '<string>',
'SizingPolicy' => '<string>',
'Target' => '<string>',
'VerticalAlign' => '<string>',
'VerticalOffset' => '<string>',
],
// ...
],
],
]);
Parameter Details
Members
- Audio
-
- Type: AudioParameters structure
A section of the request body that specifies the audio parameters.
- Container
-
- Required: Yes
- Type: string
The container type for the output file. Valid values include
flac,flv,fmp4,gif,mp3,mp4,mpg,mxf,oga,ogg,ts, andwebm. - Description
-
- Type: string
A description of the preset.
- Name
-
- Required: Yes
- Type: string
The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
- Thumbnails
-
- Type: Thumbnails structure
A section of the request body that specifies the thumbnail parameters, if any.
- Video
-
- Type: VideoParameters structure
A section of the request body that specifies the video parameters.
Result Syntax
[
'Preset' => [
'Arn' => '<string>',
'Audio' => [
'AudioPackingMode' => '<string>',
'BitRate' => '<string>',
'Channels' => '<string>',
'Codec' => '<string>',
'CodecOptions' => [
'BitDepth' => '<string>',
'BitOrder' => '<string>',
'Profile' => '<string>',
'Signed' => '<string>',
],
'SampleRate' => '<string>',
],
'Container' => '<string>',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Thumbnails' => [
'AspectRatio' => '<string>',
'Format' => '<string>',
'Interval' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
],
'Type' => '<string>',
'Video' => [
'AspectRatio' => '<string>',
'BitRate' => '<string>',
'Codec' => '<string>',
'CodecOptions' => ['<string>', ...],
'DisplayAspectRatio' => '<string>',
'FixedGOP' => '<string>',
'FrameRate' => '<string>',
'KeyframesMaxDist' => '<string>',
'MaxFrameRate' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
'Watermarks' => [
[
'HorizontalAlign' => '<string>',
'HorizontalOffset' => '<string>',
'Id' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'Opacity' => '<string>',
'SizingPolicy' => '<string>',
'Target' => '<string>',
'VerticalAlign' => '<string>',
'VerticalOffset' => '<string>',
],
// ...
],
],
],
'Warning' => '<string>',
]
Result Details
Members
- Preset
-
- Type: Preset structure
A section of the response body that provides information about the preset that is created.
- Warning
-
- Type: string
If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- LimitExceededException:
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
DeletePipeline
$result = $client->deletePipeline([/* ... */]); $promise = $client->deletePipelineAsync([/* ... */]);
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, DeletePipeline returns an error.
Parameter Syntax
$result = $client->deletePipeline([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the pipeline that you want to delete.
Result Syntax
[]
Result Details
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- ResourceInUseException:
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
DeletePreset
$result = $client->deletePreset([/* ... */]); $promise = $client->deletePresetAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->deletePreset([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the preset for which you want to get detailed information.
Result Syntax
[]
Result Details
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ListJobsByPipeline
$result = $client->listJobsByPipeline([/* ... */]); $promise = $client->listJobsByPipelineAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listJobsByPipeline([
'Ascending' => '<string>',
'PageToken' => '<string>',
'PipelineId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Ascending
-
- Type: string
To list jobs in chronological order by the date and time that they were submitted, enter
true. To list jobs in reverse chronological order, enterfalse. - PageToken
-
- Type: string
When Elastic Transcoder returns more than one page of results, use
pageTokenin subsequentGETrequests to get each successive page of results. - PipelineId
-
- Required: Yes
- Type: string
The ID of the pipeline for which you want to get job information.
Result Syntax
[
'Jobs' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'Input' => [
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
'Inputs' => [
[
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Output' => [
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
'OutputKeyPrefix' => '<string>',
'Outputs' => [
[
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
// ...
],
'PipelineId' => '<string>',
'Playlists' => [
[
'Format' => '<string>',
'HlsContentProtection' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'KeyStoragePolicy' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
'Method' => '<string>',
],
'Name' => '<string>',
'OutputKeys' => ['<string>', ...],
'PlayReadyDrm' => [
'Format' => '<string>',
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyId' => '<string>',
'KeyMd5' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
],
'Status' => '<string>',
'StatusDetail' => '<string>',
],
// ...
],
'Status' => '<string>',
'Timing' => [
'FinishTimeMillis' => <integer>,
'StartTimeMillis' => <integer>,
'SubmitTimeMillis' => <integer>,
],
'UserMetadata' => ['<string>', ...],
],
// ...
],
'NextPageToken' => '<string>',
]
Result Details
Members
- Jobs
-
- Type: Array of Job structures
An array of
Jobobjects that are in the specified pipeline. - NextPageToken
-
- Type: string
A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of
NextPageTokenisnull.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ListJobsByStatus
$result = $client->listJobsByStatus([/* ... */]); $promise = $client->listJobsByStatusAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listJobsByStatus([
'Ascending' => '<string>',
'PageToken' => '<string>',
'Status' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Ascending
-
- Type: string
To list jobs in chronological order by the date and time that they were submitted, enter
true. To list jobs in reverse chronological order, enterfalse. - PageToken
-
- Type: string
When Elastic Transcoder returns more than one page of results, use
pageTokenin subsequentGETrequests to get each successive page of results. - Status
-
- Required: Yes
- Type: string
To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status:
Submitted,Progressing,Complete,Canceled, orError.
Result Syntax
[
'Jobs' => [
[
'Arn' => '<string>',
'Id' => '<string>',
'Input' => [
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
'Inputs' => [
[
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Output' => [
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
'OutputKeyPrefix' => '<string>',
'Outputs' => [
[
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
// ...
],
'PipelineId' => '<string>',
'Playlists' => [
[
'Format' => '<string>',
'HlsContentProtection' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'KeyStoragePolicy' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
'Method' => '<string>',
],
'Name' => '<string>',
'OutputKeys' => ['<string>', ...],
'PlayReadyDrm' => [
'Format' => '<string>',
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyId' => '<string>',
'KeyMd5' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
],
'Status' => '<string>',
'StatusDetail' => '<string>',
],
// ...
],
'Status' => '<string>',
'Timing' => [
'FinishTimeMillis' => <integer>,
'StartTimeMillis' => <integer>,
'SubmitTimeMillis' => <integer>,
],
'UserMetadata' => ['<string>', ...],
],
// ...
],
'NextPageToken' => '<string>',
]
Result Details
Members
- Jobs
-
- Type: Array of Job structures
An array of
Jobobjects that have the specified status. - NextPageToken
-
- Type: string
A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of
NextPageTokenisnull.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ListPipelines
$result = $client->listPipelines([/* ... */]); $promise = $client->listPipelinesAsync([/* ... */]);
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
Parameter Syntax
$result = $client->listPipelines([
'Ascending' => '<string>',
'PageToken' => '<string>',
]);
Parameter Details
Members
- Ascending
-
- Type: string
To list pipelines in chronological order by the date and time that they were created, enter
true. To list pipelines in reverse chronological order, enterfalse. - PageToken
-
- Type: string
When Elastic Transcoder returns more than one page of results, use
pageTokenin subsequentGETrequests to get each successive page of results.
Result Syntax
[
'NextPageToken' => '<string>',
'Pipelines' => [
[
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of
NextPageTokenisnull. - Pipelines
-
- Type: Array of Pipeline structures
An array of
Pipelineobjects.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ListPresets
$result = $client->listPresets([/* ... */]); $promise = $client->listPresetsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listPresets([
'Ascending' => '<string>',
'PageToken' => '<string>',
]);
Parameter Details
Members
- Ascending
-
- Type: string
To list presets in chronological order by the date and time that they were created, enter
true. To list presets in reverse chronological order, enterfalse. - PageToken
-
- Type: string
When Elastic Transcoder returns more than one page of results, use
pageTokenin subsequentGETrequests to get each successive page of results.
Result Syntax
[
'NextPageToken' => '<string>',
'Presets' => [
[
'Arn' => '<string>',
'Audio' => [
'AudioPackingMode' => '<string>',
'BitRate' => '<string>',
'Channels' => '<string>',
'Codec' => '<string>',
'CodecOptions' => [
'BitDepth' => '<string>',
'BitOrder' => '<string>',
'Profile' => '<string>',
'Signed' => '<string>',
],
'SampleRate' => '<string>',
],
'Container' => '<string>',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Thumbnails' => [
'AspectRatio' => '<string>',
'Format' => '<string>',
'Interval' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
],
'Type' => '<string>',
'Video' => [
'AspectRatio' => '<string>',
'BitRate' => '<string>',
'Codec' => '<string>',
'CodecOptions' => ['<string>', ...],
'DisplayAspectRatio' => '<string>',
'FixedGOP' => '<string>',
'FrameRate' => '<string>',
'KeyframesMaxDist' => '<string>',
'MaxFrameRate' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
'Watermarks' => [
[
'HorizontalAlign' => '<string>',
'HorizontalOffset' => '<string>',
'Id' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'Opacity' => '<string>',
'SizingPolicy' => '<string>',
'Target' => '<string>',
'VerticalAlign' => '<string>',
'VerticalOffset' => '<string>',
],
// ...
],
],
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of
NextPageTokenisnull. - Presets
-
- Type: Array of Preset structures
An array of
Presetobjects.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ReadJob
$result = $client->readJob([/* ... */]); $promise = $client->readJobAsync([/* ... */]);
The ReadJob operation returns detailed information about a job.
Parameter Syntax
$result = $client->readJob([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the job for which you want to get detailed information.
Result Syntax
[
'Job' => [
'Arn' => '<string>',
'Id' => '<string>',
'Input' => [
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
'Inputs' => [
[
'AspectRatio' => '<string>',
'Container' => '<string>',
'DetectedProperties' => [
'DurationMillis' => <integer>,
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Width' => <integer>,
],
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FrameRate' => '<string>',
'InputCaptions' => [
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Interlaced' => '<string>',
'Key' => '<string>',
'Resolution' => '<string>',
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Output' => [
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
'OutputKeyPrefix' => '<string>',
'Outputs' => [
[
'AlbumArt' => [
'Artwork' => [
[
'AlbumArtFormat' => '<string>',
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'SizingPolicy' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'AppliedColorSpaceConversion' => '<string>',
'Captions' => [
'CaptionFormats' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Format' => '<string>',
'Pattern' => '<string>',
],
// ...
],
'CaptionSources' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'Key' => '<string>',
'Label' => '<string>',
'Language' => '<string>',
'TimeOffset' => '<string>',
],
// ...
],
'MergePolicy' => '<string>',
],
'Composition' => [
[
'TimeSpan' => [
'Duration' => '<string>',
'StartTime' => '<string>',
],
],
// ...
],
'Duration' => <integer>,
'DurationMillis' => <integer>,
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'FileSize' => <integer>,
'FrameRate' => '<string>',
'Height' => <integer>,
'Id' => '<string>',
'Key' => '<string>',
'PresetId' => '<string>',
'Rotate' => '<string>',
'SegmentDuration' => '<string>',
'Status' => '<string>',
'StatusDetail' => '<string>',
'ThumbnailEncryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'ThumbnailPattern' => '<string>',
'Watermarks' => [
[
'Encryption' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'Mode' => '<string>',
],
'InputKey' => '<string>',
'PresetWatermarkId' => '<string>',
],
// ...
],
'Width' => <integer>,
],
// ...
],
'PipelineId' => '<string>',
'Playlists' => [
[
'Format' => '<string>',
'HlsContentProtection' => [
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyMd5' => '<string>',
'KeyStoragePolicy' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
'Method' => '<string>',
],
'Name' => '<string>',
'OutputKeys' => ['<string>', ...],
'PlayReadyDrm' => [
'Format' => '<string>',
'InitializationVector' => '<string>',
'Key' => '<string>',
'KeyId' => '<string>',
'KeyMd5' => '<string>',
'LicenseAcquisitionUrl' => '<string>',
],
'Status' => '<string>',
'StatusDetail' => '<string>',
],
// ...
],
'Status' => '<string>',
'Timing' => [
'FinishTimeMillis' => <integer>,
'StartTimeMillis' => <integer>,
'SubmitTimeMillis' => <integer>,
],
'UserMetadata' => ['<string>', ...],
],
]
Result Details
Members
- Job
-
- Type: Job structure
A section of the response body that provides information about the job.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ReadPipeline
$result = $client->readPipeline([/* ... */]); $promise = $client->readPipelineAsync([/* ... */]);
The ReadPipeline operation gets detailed information about a pipeline.
Parameter Syntax
$result = $client->readPipeline([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the pipeline to read.
Result Syntax
[
'Pipeline' => [
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
'Warnings' => [
[
'Code' => '<string>',
'Message' => '<string>',
],
// ...
],
]
Result Details
Members
- Pipeline
-
- Type: Pipeline structure
A section of the response body that provides information about the pipeline.
- Warnings
-
- Type: Array of Warning structures
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.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
ReadPreset
$result = $client->readPreset([/* ... */]); $promise = $client->readPresetAsync([/* ... */]);
The ReadPreset operation gets detailed information about a preset.
Parameter Syntax
$result = $client->readPreset([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the preset for which you want to get detailed information.
Result Syntax
[
'Preset' => [
'Arn' => '<string>',
'Audio' => [
'AudioPackingMode' => '<string>',
'BitRate' => '<string>',
'Channels' => '<string>',
'Codec' => '<string>',
'CodecOptions' => [
'BitDepth' => '<string>',
'BitOrder' => '<string>',
'Profile' => '<string>',
'Signed' => '<string>',
],
'SampleRate' => '<string>',
],
'Container' => '<string>',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'Thumbnails' => [
'AspectRatio' => '<string>',
'Format' => '<string>',
'Interval' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
],
'Type' => '<string>',
'Video' => [
'AspectRatio' => '<string>',
'BitRate' => '<string>',
'Codec' => '<string>',
'CodecOptions' => ['<string>', ...],
'DisplayAspectRatio' => '<string>',
'FixedGOP' => '<string>',
'FrameRate' => '<string>',
'KeyframesMaxDist' => '<string>',
'MaxFrameRate' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'PaddingPolicy' => '<string>',
'Resolution' => '<string>',
'SizingPolicy' => '<string>',
'Watermarks' => [
[
'HorizontalAlign' => '<string>',
'HorizontalOffset' => '<string>',
'Id' => '<string>',
'MaxHeight' => '<string>',
'MaxWidth' => '<string>',
'Opacity' => '<string>',
'SizingPolicy' => '<string>',
'Target' => '<string>',
'VerticalAlign' => '<string>',
'VerticalOffset' => '<string>',
],
// ...
],
],
],
]
Result Details
Members
- Preset
-
- Type: Preset structure
A section of the response body that provides information about the preset.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
TestRole
$result = $client->testRole([/* ... */]); $promise = $client->testRoleAsync([/* ... */]);
The TestRole operation tests the IAM role used to create the pipeline.
The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.
Parameter Syntax
$result = $client->testRole([
'InputBucket' => '<string>', // REQUIRED
'OutputBucket' => '<string>', // REQUIRED
'Role' => '<string>', // REQUIRED
'Topics' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- InputBucket
-
- Required: Yes
- Type: string
The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
- OutputBucket
-
- Required: Yes
- Type: string
The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.
- Role
-
- Required: Yes
- Type: string
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
- Topics
-
- Required: Yes
- Type: Array of strings
The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.
Result Syntax
[
'Messages' => ['<string>', ...],
'Success' => '<string>',
]
Result Details
Members
- Messages
-
- Type: Array of strings
If the
Successelement containsfalse, this value is an array of one or more error messages that were generated during the test process. - Success
-
- Type: string
If the operation is successful, this value is
true; otherwise, the value isfalse.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
UpdatePipeline
$result = $client->updatePipeline([/* ... */]); $promise = $client->updatePipelineAsync([/* ... */]);
Use the UpdatePipeline operation to update settings for a pipeline.
When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.
Parameter Syntax
$result = $client->updatePipeline([
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>', // REQUIRED
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'Role' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
]);
Parameter Details
Members
- AwsKmsKeyArn
-
- Type: string
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either
s3ors3-aws-kmsas yourEncryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using anEncryption:Modeofaes-cbc-pkcs7,aes-ctr, oraes-gcm. - ContentConfig
-
- Type: PipelineOutputConfig structure
The optional
ContentConfigobject specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig, you must also specify values forThumbnailConfig.If you specify values for
ContentConfigandThumbnailConfig, omit theOutputBucketobject.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
-
Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
-
Grantee Type: Specify the type of value that appears in the
Granteeobject:-
Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Granteeobject is the registered email address of an AWS account. -
Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:-
READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee hasREAD,READ_ACP, andWRITE_ACPpermissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
- Id
-
- Required: Yes
- Type: string
The ID of the pipeline that you want to update.
- InputBucket
-
- Type: string
The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.
- Name
-
- Type: string
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
- Notifications
-
- Type: Notifications structure
The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
-
Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
-
Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
-
Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
- Role
-
- Type: string
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.
- ThumbnailConfig
-
- Type: PipelineOutputConfig structure
The
ThumbnailConfigobject specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig, you must also specify values forThumbnailConfigeven if you don't want to create thumbnails.If you specify values for
ContentConfigandThumbnailConfig, omit theOutputBucketobject.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
-
Permissions (Optional): The
Permissionsobject specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. -
GranteeType: Specify the type of value that appears in the Grantee object:
-
Canonical: The value in the
Granteeobject is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Granteeobject is the registered email address of an AWS account. -
Group: The value in the
Granteeobject is one of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:-
READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee hasREAD,READ_ACP, andWRITE_ACPpermissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
Result Syntax
[
'Pipeline' => [
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
'Warnings' => [
[
'Code' => '<string>',
'Message' => '<string>',
],
// ...
],
]
Result Details
Members
- Pipeline
-
- Type: Pipeline structure
The pipeline updated by this
UpdatePipelineResponsecall. - Warnings
-
- Type: Array of Warning structures
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.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- ResourceInUseException:
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
UpdatePipelineNotifications
$result = $client->updatePipelineNotifications([/* ... */]); $promise = $client->updatePipelineNotificationsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updatePipelineNotifications([
'Id' => '<string>', // REQUIRED
'Notifications' => [ // REQUIRED
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the pipeline for which you want to change notification settings.
- Notifications
-
- Required: Yes
- Type: Notifications structure
The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
-
Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
-
Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
-
Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
Result Syntax
[
'Pipeline' => [
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
]
Result Details
Members
- Pipeline
-
- Type: Pipeline structure
A section of the response body that provides information about the pipeline associated with this notification.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- ResourceInUseException:
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
UpdatePipelineStatus
$result = $client->updatePipelineStatus([/* ... */]); $promise = $client->updatePipelineStatusAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updatePipelineStatus([
'Id' => '<string>', // REQUIRED
'Status' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The identifier of the pipeline to update.
- Status
-
- Required: Yes
- Type: string
The desired status of the pipeline:
-
Active: The pipeline is processing jobs. -
Paused: The pipeline is not currently processing jobs.
Result Syntax
[
'Pipeline' => [
'Arn' => '<string>',
'AwsKmsKeyArn' => '<string>',
'ContentConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
'Id' => '<string>',
'InputBucket' => '<string>',
'Name' => '<string>',
'Notifications' => [
'Completed' => '<string>',
'Error' => '<string>',
'Progressing' => '<string>',
'Warning' => '<string>',
],
'OutputBucket' => '<string>',
'Role' => '<string>',
'Status' => '<string>',
'ThumbnailConfig' => [
'Bucket' => '<string>',
'Permissions' => [
[
'Access' => ['<string>', ...],
'Grantee' => '<string>',
'GranteeType' => '<string>',
],
// ...
],
'StorageClass' => '<string>',
],
],
]
Result Details
Members
- Pipeline
-
- Type: Pipeline structure
A section of the response body that provides information about the pipeline.
Errors
- ValidationException:
One or more required parameter values were not provided in the request.
- IncompatibleVersionException:
- This error does not currently have a description.
- ResourceNotFoundException:
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
- ResourceInUseException:
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
- AccessDeniedException:
General authentication failure. The request was not signed correctly.
- InternalServiceException:
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
Shapes
AccessDeniedException
Description
General authentication failure. The request was not signed correctly.
Members
Artwork
Description
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 Artwork to null, or set the Merge Policy to "Replace" and use an empty Artwork array.
To pass through existing artwork unchanged, set the Merge Policy to "Prepend", "Append", or "Fallback", and use an empty Artwork array.
Members
- AlbumArtFormat
-
- Type: string
The format of album art, if any. Valid formats are
.jpgand.png. - Encryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
- InputKey
-
- Type: string
The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by
PipelineId; theInputBucketobject in that pipeline identifies the bucket.If the file name includes a prefix, for example,
cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. - MaxHeight
-
- Type: string
The maximum height of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive. - MaxWidth
-
- Type: string
The maximum width of the output album art in pixels. If you specify
auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive. - PaddingPolicy
-
- Type: string
When you set
PaddingPolicytoPad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified forMaxWidthandMaxHeight. - SizingPolicy
-
- Type: string
Specify one of the following values to control scaling of the output album art:
-
Fit:Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidthorMaxHeightwithout exceeding the other value. -
Fill:Elastic Transcoder scales the output art so it matches the value that you specified in eitherMaxWidthorMaxHeightand matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch:Elastic Transcoder stretches the output art to match the values that you specified forMaxWidthandMaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted. -
Keep:Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified forMaxWidthandMaxHeight, Elastic Transcoder crops the output art. -
ShrinkToFit:Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up. -
ShrinkToFillElastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
AudioCodecOptions
Description
Options associated with your audio codec.
Members
- BitDepth
-
- Type: string
You can only choose an audio bit depth when you specify
flacorpcmfor the value of Audio:Codec.The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.
Valid values are
16and24.The most common bit depth is
24. - BitOrder
-
- Type: string
You can only choose an audio bit order when you specify
pcmfor the value of Audio:Codec.The order the bits of a PCM sample are stored in.
The supported value is
LittleEndian. - Profile
-
- Type: string
You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
-
auto: If you specifyauto, Elastic Transcoder selects the profile based on the bit rate selected for the output file. -
AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps. -
HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps. -
HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.
All outputs in a
Smoothplaylist must have the same value forProfile.If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.
- Signed
-
- Type: string
You can only choose whether an audio sample is signed when you specify
pcmfor the value of Audio:Codec.Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).
The supported value is
Signed.
AudioParameters
Description
Parameters required for transcoding audio.
Members
- AudioPackingMode
-
- Type: string
The method of organizing audio channels and tracks. Use
Audio:Channelsto specify the number of channels in your output, andAudio:AudioPackingModeto specify the number of tracks and their relation to the channels. If you do not specify anAudio:AudioPackingMode, Elastic Transcoder usesSingleTrack.The following values are valid:
SingleTrack,OneChannelPerTrack, andOneChannelPerTrackWithMosTo8TracksWhen you specify
SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. UseSingleTrackfor all non-mxfcontainers.The outputs of
SingleTrackfor a specific channel value and inputs are as follows:-
0channels with any input: Audio omitted from the output -
1, 2, or autochannels with no audio input: Audio omitted from the output -
1channel with any input with audio: One track with one channel, downmixed if necessary -
2channels with one track with one channel: One track with two identical channels -
2 or autochannels with two tracks with one channel each: One track with two channels -
2 or autochannels with one track with two channels: One track with two channels -
2channels with one track with multiple channels: One track with two channels -
autochannels with one track with one channel: One track with one channel -
autochannels with one track with multiple channels: One track with multiple channels
When you specify
OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.The outputs of
OneChannelPerTrackfor a specific channel value and inputs are as follows:-
0channels with any input: Audio omitted from the output -
1, 2, or autochannels with no audio input: Audio omitted from the output -
1channel with any input with audio: One track with one channel, downmixed if necessary -
2channels with one track with one channel: Two tracks with one identical channel each -
2 or autochannels with two tracks with one channel each: Two tracks with one channel each -
2 or autochannels with one track with two channels: Two tracks with one channel each -
2channels with one track with multiple channels: Two tracks with one channel each -
autochannels with one track with one channel: One track with one channel -
autochannels with one track with multiple channels: Up to eight tracks with one channel each
When you specify
OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.The outputs of
OneChannelPerTrackWithMosTo8Tracksfor a specific channel value and inputs are as follows:-
0channels with any input: Audio omitted from the output -
1, 2, or autochannels with no audio input: Audio omitted from the output -
1channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks -
2channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks -
2 or autochannels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks -
2 or autochannels with one track with two channels: Two tracks with one channel each, plus six MOS tracks -
2channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks -
autochannels with one track with one channel: One track with one channel, plus seven MOS tracks -
autochannels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all
- BitRate
-
- Type: string
The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.
- Channels
-
- Type: string
The number of audio channels in the output file. The following values are valid:
auto,0,1,2One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select
auto.The output of a specific channel value and inputs are as follows:
-
autochannel specified, with any input: Pass through up to eight input channels. -
0channels specified, with any input: Audio omitted from the output. -
1channel specified, with at least one input channel: Mono sound. -
2channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, seeAudio:AudioPackingMode.
For more information about how Elastic Transcoder organizes channels and tracks, see
Audio:AudioPackingMode. - Codec
-
- Type: string
The audio codec for the output file. Valid values include
aac,flac,mp2,mp3,pcm, andvorbis. - CodecOptions
-
- Type: AudioCodecOptions structure
If you specified
AACforAudio:Codec, this is theAACcompression profile to use. Valid values include:auto,AAC-LC,HE-AAC,HE-AACv2If you specify
auto, Elastic Transcoder chooses a profile based on the bit rate of the output file. - SampleRate
-
- Type: string
The sample rate of the audio stream in the output file, in Hertz. Valid values include:
auto,22050,32000,44100,48000,96000If you specify
auto, Elastic Transcoder automatically detects the sample rate.
CaptionFormat
Description
The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.
Members
- Encryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
- Format
-
- Type: string
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
-
Valid Embedded Caption Formats:
-
for FLAC: None
-
For MP3: None
-
For MP4: mov-text
-
For MPEG-TS: None
-
For ogg: None
-
For webm: None
-
-
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
-
For FMP4: dfxp
-
Non-FMP4 outputs: All sidecar types
fmp4captions have an extension of.ismt -
- Pattern
-
- Type: string
The prefix for caption filenames, in the form description-
{language}, where:-
description is a description of the video.
-
{language}is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.
If you don't include
{language}in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.
CaptionSource
Description
A source file for the input sidecar captions used during the transcoding process.
Members
- Encryption
-
- Type: Encryption structure
The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.
- Key
-
- Type: string
The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
- Label
-
- Type: string
The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.
- Language
-
- Type: string
A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:
-
2-character ISO 639-1 code
-
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
- TimeOffset
-
- Type: string
For clip generation or captions that do not start at the same time as the associated video file, the
TimeOffsettells Elastic Transcoder how much of the video to encode before including captions.Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
Captions
Description
The captions to be created, if any.
Members
- CaptionFormats
-
- Type: Array of CaptionFormat structures
The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
- CaptionSources
-
- Type: Array of CaptionSource structures
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSourcesblank. - MergePolicy
-
- Type: string
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSourcesis empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources.
MergePolicycannot be null.
Clip
Description
Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.
Members
- TimeSpan
-
- Type: TimeSpan structure
Settings that determine when a clip begins and how long it lasts.
CreateJobOutput
Description
The CreateJobOutput structure.
Members
- AlbumArt
-
- Type: JobAlbumArt structure
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.
- Captions
-
- Type: Captions structure
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:
-
Embedded: 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.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
-
Sidecar: 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.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
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.
To remove captions or leave the captions empty, set
Captionsto null. To pass through existing captions unchanged, set theMergePolicytoMergeRetain, and pass in a nullCaptionSourcesarray.For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
- Composition
-
- Type: Array of Clip structures
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.
- Encryption
-
- Type: Encryption structure
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.
- Key
-
- Type: string
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the
OutputBucketobject 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. - PresetId
-
- Type: string
The
Idof the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. - Rotate
-
- Type: string
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:
auto,0,90,180,270. The valueautogenerally works only if the file that you're transcoding contains rotation metadata. - SegmentDuration
-
- Type: string
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetIdfor which the value ofContainerisfmp4(Fragmented MP4) orts(MPEG-TS),SegmentDurationis the target maximum duration of each segment in seconds. ForHLSv3format playlists, each media segment is stored in a separate.tsfile. ForHLSv4andSmoothplaylists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration, though individual segments might be shorter or longer.The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by
SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.Elastic Transcoder creates an output-specific playlist for each output
HLSoutput that you specify in OutputKeys. To add an output to the master playlist for this job, include it in theOutputKeysof the associated playlist. - ThumbnailEncryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
- ThumbnailPattern
-
- Type: string
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
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:
-
{count}(Required): If you want to create thumbnails, you must include{count}in theThumbnailPatternobject. Wherever you specify{count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.If you specify a literal value and/or
{resolution}but you omit{count}, Elastic Transcoder returns a validation error and does not create the job. -
Literal values (Optional): You can specify literal values anywhere in the
ThumbnailPatternobject. For example, you can include them as a file name prefix or as a delimiter between{resolution}and{count}. -
{resolution}(Optional): If you want Elastic Transcoder to include the resolution in the file name, include{resolution}in theThumbnailPatternobject.
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
PresetIDvalue ofCreateJobOutput. Elastic Transcoder also appends the applicable file name extension. - Watermarks
-
- Type: Array of JobWatermark structures
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.
CreateJobPlaylist
Description
Information about the master playlist.
Members
- Format
-
- Type: string
The format of the output playlist. Valid formats include
HLSv3,HLSv4, andSmooth. - HlsContentProtection
-
- Type: HlsContentProtection structure
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Name
-
- Type: string
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a
/character, the section of the name before the last/must be identical for allNameobjects. If you create more than one master playlist, the values of allNameobjects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8forHLSv3andHLSv4playlists, and.ismand.ismcforSmoothplaylists). If you include a file extension inName, the file name will have two extensions. - OutputKeys
-
- Type: Array of strings
For each output in this job that you want to include in a master playlist, the value of the
Outputs:Keyobject.-
If your output is not
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:Key -
If your output is
HLSv3and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8, and a series of.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.ts -
If your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8:OutputKeyPrefix
Outputs:Key_v4.m3u8OutputKeyPrefix
Outputs:Key_iframe.m3u8OutputKeyPrefix
Outputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smoothplaylists, theAudio:Profile,Video:Profile, andVideo:FrameRatetoVideo:KeyframesMaxDistratio must be the same for all outputs. - PlayReadyDrm
-
- Type: PlayReadyDrm structure
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
DetectedProperties
Description
The detected properties of the input file. Elastic Transcoder identifies these values from the input file.
Members
- DurationMillis
-
- Type: long (int|float)
The detected duration of the input file, in milliseconds.
- FileSize
-
- Type: long (int|float)
The detected file size of the input file, in bytes.
- FrameRate
-
- Type: string
The detected frame rate of the input file, in frames per second.
- Height
-
- Type: int
The detected height of the input file, in pixels.
- Width
-
- Type: int
The detected width of the input file, in pixels.
Encryption
Description
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 uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.
Members
- InitializationVector
-
- Type: string
The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
- Key
-
- Type: string
The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:
128,192, or256.The key must also be encrypted by using the Amazon Key Management Service.
- KeyMd5
-
- Type: string
The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
- Mode
-
- Type: string
The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:
-
s3: Amazon S3 creates and manages the keys used for encrypting your files.
-
s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify
s3-aws-kmsand you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline. -
aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.
-
aes-ctr: AES Counter Mode.
-
aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
-
Key
-
Key MD5
-
Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
HlsContentProtection
Description
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.
Members
- InitializationVector
-
- Type: string
If Elastic Transcoder is generating your key for you, you must leave this field blank.
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
- Key
-
- Type: string
If you want Elastic Transcoder to generate a key for you, leave this field blank.
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128,192, or256. - KeyMd5
-
- Type: string
If Elastic Transcoder is generating your key for you, you must leave this field blank.
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
- KeyStoragePolicy
-
- Type: string
Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose
WithVariantPlaylists,LicenseAcquisitionUrlmust be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist. - LicenseAcquisitionUrl
-
- Type: string
The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
- Method
-
- Type: string
The content protection method for your output. The only valid value is:
aes-128.This value is written into the method attribute of the
EXT-X-KEYmetadata tag in the output playlist.
IncompatibleVersionException
Members
InputCaptions
Description
The captions to be created, if any.
Members
- CaptionSources
-
- Type: Array of CaptionSource structures
Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave
CaptionSourcesblank. - MergePolicy
-
- Type: string
A policy that determines how Elastic Transcoder handles the existence of multiple captions.
-
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
-
MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
CaptionSourcesis empty, Elastic Transcoder omits all sidecar captions from the output files. -
Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
CaptionSources.
MergePolicycannot be null.
InternalServiceException
Description
Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.
Members
Job
Description
A section of the response body that provides information about the job that is created.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the job.
- Id
-
- Type: string
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
- Input
-
- Type: JobInput structure
A section of the request or response body that provides information about the file that is being transcoded.
- Inputs
-
- Type: Array of JobInput structures
Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.
- Output
-
- Type: JobOutput structure
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Outputs recommended instead.
A section of the request or response body that provides information about the transcoded (target) file.
- OutputKeyPrefix
-
- Type: string
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the
OutputKeyPrefix. - Outputs
-
- Type: Array of JobOutput structures
Information about the output files. We recommend that you use the
Outputssyntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputsandOutputsyntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- PipelineId
-
- Type: string
The
Idof 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. - Playlists
-
- Type: Array of Playlist structures
Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetIdfor which the value ofContaineris fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlistscontains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
- Status
-
- Type: string
The status of the job:
Submitted,Progressing,Complete,Canceled, orError. - Timing
-
- Type: Timing structure
Details about the timing of a job.
- UserMetadata
-
- Type: Associative array of custom strings keys (String) to strings
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
key/valuepairs, and you can add up to 10key/valuepairs per job. Elastic Transcoder does not guarantee thatkey/valuepairs are returned in the same order in which you specify them.Metadata
keysandvaluesmust use characters from the following list:-
0-9 -
A-Zanda-z -
Space -
The following symbols:
_.:/=+-%@
JobAlbumArt
Description
The .jpg or .png file associated with an audio file.
Members
- Artwork
-
- Type: Array of Artwork structures
The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are
.jpgand.png - MergePolicy
-
- Type: string
A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.
-
Replace:The specified album art replaces any existing album art. -
Prepend:The specified album art is placed in front of any existing album art. -
Append:The specified album art is placed after any existing album art. -
Fallback:If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.
JobInput
Description
Information about the file that you're transcoding.
Members
- AspectRatio
-
- Type: string
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify
auto. If you want to specify the aspect ratio for the output file, enter one of the following values:1:1,4:3,3:2,16:9If you specify a value other than
auto, Elastic Transcoder disables automatic detection of the aspect ratio. - Container
-
- Type: string
The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify
auto. If you want to specify the container type for the input file, enter one of the following values:3gp,aac,asf,avi,divx,flv,m4a,mkv,mov,mp3,mp4,mpeg,mpeg-ps,mpeg-ts,mxf,ogg,vob,wav,webm - DetectedProperties
-
- Type: DetectedProperties structure
The detected properties of the input file.
- Encryption
-
- Type: Encryption structure
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.
- FrameRate
-
- Type: string
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify
auto. If you want to specify the frame rate for the input file, enter one of the following values:10,15,23.97,24,25,29.97,30,60If you specify a value other than
auto, Elastic Transcoder disables automatic detection of the frame rate. - InputCaptions
-
- Type: InputCaptions structure
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:
-
Embedded: 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.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
-
Sidecar: 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.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
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.
To remove captions or leave the captions empty, set
Captionsto null. To pass through existing captions unchanged, set theMergePolicytoMergeRetain, and pass in a nullCaptionSourcesarray.For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
- Interlaced
-
- Type: string
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify
auto. If you want to specify whether the input file is interlaced, enter one of the following values:true,falseIf you specify a value other than
auto, Elastic Transcoder disables automatic detection of interlacing. - Key
-
- Type: string
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
InputBucketobject in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.If the file name includes a prefix, such as
cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error. - Resolution
-
- Type: string
This value must be
auto, which causes Elastic Transcoder to automatically detect the resolution of the input file. - TimeSpan
-
- Type: TimeSpan structure
Settings for clipping an input. Each input can have different clip settings.
JobOutput
Description
Outputs recommended instead.
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Members
- AlbumArt
-
- Type: JobAlbumArt structure
The album art to be associated with the output file, if any.
- AppliedColorSpaceConversion
-
- Type: string
If Elastic Transcoder used a preset with a
ColorSpaceConversionModeto transcode the output file, theAppliedColorSpaceConversionparameter shows the conversion used. If noColorSpaceConversionModewas defined in the preset, this parameter is not be included in the job response. - Captions
-
- Type: Captions structure
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:
-
Embedded: 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.
Valid input values include:
CEA-608 (EIA-608, first non-empty channel only),CEA-708 (EIA-708, first non-empty channel only), andmov-textValid outputs include:
mov-textElastic Transcoder supports a maximum of one embedded format per output.
-
Sidecar: 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.
Valid input values include:
dfxp(first div element only),ebu-tt,scc,smpt,srt,ttml(first div element only), andwebvttValid outputs include:
dfxp(first div element only),scc,srt, andwebvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
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.
To remove captions or leave the captions empty, set
Captionsto null. To pass through existing captions unchanged, set theMergePolicytoMergeRetain, and pass in a nullCaptionSourcesarray.For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
- Composition
-
- Type: Array of Clip structures
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.
- Duration
-
- Type: long (int|float)
Duration of the output file, in seconds.
- DurationMillis
-
- Type: long (int|float)
Duration of the output file, in milliseconds.
- Encryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.
- FileSize
-
- Type: long (int|float)
File size of the output file, in bytes.
- FrameRate
-
- Type: string
Frame rate of the output file, in frames per second.
- Height
-
- Type: int
Height of the output file, in pixels.
- Id
-
- Type: string
A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.
- Key
-
- Type: string
The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the
OutputBucketobject in the pipeline that is specified by the pipeline ID. - PresetId
-
- Type: string
The value of the
Idobject for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get withListPresets. - Rotate
-
- Type: string
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:
auto,0,90,180,270The value
autogenerally works only if the file that you're transcoding contains rotation metadata. - SegmentDuration
-
- Type: string
(Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetIdfor which the value ofContainerisfmp4(Fragmented MP4) orts(MPEG-TS),SegmentDurationis the target maximum duration of each segment in seconds. ForHLSv3format playlists, each media segment is stored in a separate.tsfile. ForHLSv4,MPEG-DASH, andSmoothplaylists, all media segments for an output are stored in a single file. Each segment is approximately the length of theSegmentDuration, though individual segments might be shorter or longer.The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by
SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.Elastic Transcoder creates an output-specific playlist for each output
HLSoutput that you specify in OutputKeys. To add an output to the master playlist for this job, include it in theOutputKeysof the associated playlist. - Status
-
- Type: string
The status of one output in a job. If you specified only one output for the job,
Outputs:Statusis always the same asJob:Status. If you specified more than one output:-
Job:StatusandOutputs:Statusfor all of the outputs is Submitted until Elastic Transcoder starts to process the first output. -
When Elastic Transcoder starts to process the first output,
Outputs:Statusfor that output andJob:Statusboth change to Progressing. For each output, the value ofOutputs:Statusremains Submitted until Elastic Transcoder starts to process the output. -
Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
-
When all of the outputs reach a terminal status,
Job:Statuschanges to Complete only ifOutputs:Statusfor all of the outputs isComplete. IfOutputs:Statusfor one or more outputs isError, the terminal status forJob:Statusis alsoError.
The value of
Statusis one of the following:Submitted,Progressing,Complete,Canceled, orError. - StatusDetail
-
- Type: string
Information that further explains
Status. - ThumbnailEncryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
- ThumbnailPattern
-
- Type: string
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
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:
-
{count}(Required): If you want to create thumbnails, you must include{count}in theThumbnailPatternobject. Wherever you specify{count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.If you specify a literal value and/or
{resolution}but you omit{count}, Elastic Transcoder returns a validation error and does not create the job. -
Literal values (Optional): You can specify literal values anywhere in the
ThumbnailPatternobject. For example, you can include them as a file name prefix or as a delimiter between{resolution}and{count}. -
{resolution}(Optional): If you want Elastic Transcoder to include the resolution in the file name, include{resolution}in theThumbnailPatternobject.
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
PresetIDvalue ofCreateJobOutput. Elastic Transcoder also appends the applicable file name extension. - Watermarks
-
- Type: Array of JobWatermark structures
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 that you specify in
Presetfor the current output.Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third.
- Width
-
- Type: int
Specifies the width of the output file in pixels.
JobWatermark
Description
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.
Members
- Encryption
-
- Type: Encryption structure
The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
- InputKey
-
- Type: string
The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by
Pipeline; theInput Bucketobject in that pipeline identifies the bucket.If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
- PresetWatermarkId
-
- Type: string
The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.
LimitExceededException
Description
Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.
Members
Notifications
Description
The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
Members
- Completed
-
- Type: string
The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
- Error
-
- Type: string
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
- Progressing
-
- Type: string
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
- Warning
-
- Type: string
The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
Permission
Description
The Permission structure.
Members
- Access
-
- Type: Array of strings
The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
-
READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
- Grantee
-
- Type: string
The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
- GranteeType
-
- Type: string
The type of value that appears in the Grantee object:
-
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.A canonical user ID is not the same as an AWS account number.
-
Email: The registered email address of an AWS account. -
Group: One of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
Pipeline
Description
The pipeline (queue) that is used to manage jobs.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the pipeline.
- AwsKmsKeyArn
-
- Type: string
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either
s3ors3-aws-kmsas yourEncryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using anEncryption:Modeofaes-cbc-pkcs7,aes-ctr, oraes-gcm. - ContentConfig
-
- Type: PipelineOutputConfig structure
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both
ContentConfigandThumbnailConfig, or you specifyOutputBucket.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
-
Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.
-
GranteeType: The type of value that appears in the
Granteeobject:-
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. -
Email: The registered email address of an AWS account. -
Group: One of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to transcoded files and playlists. -
Access: The permission that you want to give to the AWS user that is listed inGrantee. Valid values include:-
READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee hasREAD,READ_ACP, andWRITE_ACPpermissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
-
StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
- Id
-
- Type: string
The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.
- InputBucket
-
- Type: string
The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.
- Name
-
- Type: string
The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.
Constraints: Maximum 40 characters
- Notifications
-
- Type: Notifications structure
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
-
Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
-
Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
-
Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
-
Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
- OutputBucket
-
- Type: string
The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both
ContentConfigandThumbnailConfig. - Role
-
- Type: string
The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
- Status
-
- Type: string
The current status of the pipeline:
-
Active: The pipeline is processing jobs. -
Paused: The pipeline is not currently processing jobs.
- ThumbnailConfig
-
- Type: PipelineOutputConfig structure
Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both
ContentConfigandThumbnailConfig, or you specifyOutputBucket.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. -
Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.-
GranteeType: The type of value that appears in the Grantee object:
-
Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.A canonical user ID is not the same as an AWS account number.
-
Email: The registered email address of an AWS account. -
Group: One of the following predefined Amazon S3 groups:AllUsers,AuthenticatedUsers, orLogDelivery.
-
-
Grantee: The AWS user or group that you want to have access to thumbnail files. -
Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
-
READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket. -
FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
-
StorageClass: The Amazon S3 storage class,StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
PipelineOutputConfig
Description
The PipelineOutputConfig structure.
Members
- Bucket
-
- Type: string
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:
-
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
-
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
-
You do not want to specify the permissions that Elastic Transcoder grants to the files.
-
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for
ContentConfigandThumbnailConfiginstead. - Permissions
-
- Type: Array of Permission structures
Optional. The
Permissionsobject specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.If you include
Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified byRole. If you want that user to have full control, you must explicitly grant full control to the user.If you omit
Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified byRole, and grants no other permissions to any other user or group. - StorageClass
-
- Type: string
The Amazon S3 storage class,
StandardorReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
PlayReadyDrm
Description
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 aes-ctr encryption.
If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.
Members
- Format
-
- Type: string
The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- InitializationVector
-
- Type: string
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you.
- Key
-
- Type: string
The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128,192, or256.The key must also be encrypted by using AWS KMS.
- KeyId
-
- Type: string
The ID for your DRM key, so that your DRM license provider knows which key to provide.
The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.
- KeyMd5
-
- Type: string
The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
- LicenseAcquisitionUrl
-
- Type: string
The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this:
https://www.example.com/exampleKey/
Playlist
Description
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.
Members
- Format
-
- Type: string
The format of the output playlist. Valid formats include
HLSv3,HLSv4, andSmooth. - HlsContentProtection
-
- Type: HlsContentProtection structure
The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Name
-
- Type: string
The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a
/character, the section of the name before the last/must be identical for allNameobjects. If you create more than one master playlist, the values of allNameobjects must be unique.Elastic Transcoder automatically appends the relevant file extension to the file name (
.m3u8forHLSv3andHLSv4playlists, and.ismand.ismcforSmoothplaylists). If you include a file extension inName, the file name will have two extensions. - OutputKeys
-
- Type: Array of strings
For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
-
If your output is not
HLSor does not have a segment duration set, the name of the output file is a concatenation ofOutputKeyPrefixandOutputs:Key:OutputKeyPrefix
Outputs:Key -
If your output is
HLSv3and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of.m3u8, and a series of.tsfiles that include a five-digit sequential counter beginning with 00000:OutputKeyPrefix
Outputs:Key.m3u8OutputKeyPrefix
Outputs:Key00000.ts -
If your output is
HLSv4, has a segment duration set, and is included in anHLSv4playlist, Elastic Transcoder creates an output playlist file with a file extension of_v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of_iframe.m3u8:OutputKeyPrefix
Outputs:Key_v4.m3u8OutputKeyPrefix
Outputs:Key_iframe.m3u8OutputKeyPrefix
Outputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For
Smoothplaylists, theAudio:Profile,Video:Profile, andVideo:FrameRatetoVideo:KeyframesMaxDistratio must be the same for all outputs. - PlayReadyDrm
-
- Type: PlayReadyDrm structure
The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
- Status
-
- Type: string
The status of the job with which the playlist is associated.
- StatusDetail
-
- Type: string
Information that further explains the status.
Preset
Description
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.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the preset.
- Audio
-
- Type: AudioParameters structure
A section of the response body that provides information about the audio preset values.
- Container
-
- Type: string
The container type for the output file. Valid values include
flac,flv,fmp4,gif,mp3,mp4,mpg,mxf,oga,ogg,ts, andwebm. - Description
-
- Type: string
A description of the preset.
- Id
-
- Type: string
Identifier for the new preset. You use this value to get settings for the preset or to delete it.
- Name
-
- Type: string
The name of the preset.
- Thumbnails
-
- Type: Thumbnails structure
A section of the response body that provides information about the thumbnail preset values, if any.
- Type
-
- Type: string
Whether the preset is a default preset provided by Elastic Transcoder (
System) or a preset that you have defined (Custom). - Video
-
- Type: VideoParameters structure
A section of the response body that provides information about the video preset values.
PresetWatermark
Description
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.
Members
- HorizontalAlign
-
- Type: string
The horizontal position of the watermark unless you specify a non-zero value for
HorizontalOffset:-
Left: The left edge of the watermark is aligned with the left border of the video.
-
Right: The right edge of the watermark is aligned with the right border of the video.
-
Center: The watermark is centered between the left and right borders.
- HorizontalOffset
-
- Type: string
The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:
-
number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.
-
integer percentage (%): The range of valid values is 0 to 100.
For example, if you specify Left for
HorizontalAlignand 5px forHorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.HorizontalOffsetis only valid when the value ofHorizontalAlignisLeftorRight. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.Use the value of
Targetto specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation. - Id
-
- Type: string
A unique identifier for the settings for one watermark. The value of
Idcan be up to 40 characters long. - MaxHeight
-
- Type: string
The maximum height of the watermark in one of the following formats:
-
number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of
MaxHeight. -
integer percentage (%): The range of valid values is 0 to 100. Use the value of
Targetto specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.
If you specify the value in pixels, it must be less than or equal to the value of
MaxHeight. - MaxWidth
-
- Type: string
The maximum width of the watermark in one of the following formats:
-
number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of
MaxWidth. -
integer percentage (%): The range of valid values is 0 to 100. Use the value of
Targetto specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.If you specify the value in pixels, it must be less than or equal to the value of
MaxWidth.
- Opacity
-
- Type: string
A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of
Opacityis float.Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for
Opacity. The .jpg file format doesn't support transparency. - SizingPolicy
-
- Type: string
A value that controls scaling of the watermark:
-
Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either
MaxWidthorMaxHeightwithout exceeding the other value. -
Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for
MaxWidthandMaxHeight. If the relative proportions of the watermark and the values ofMaxWidthandMaxHeightare different, the watermark will be distorted. -
ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of
MaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.
- Target
-
- Type: string
A value that determines how Elastic Transcoder interprets values that you specified for
HorizontalOffset,VerticalOffset,MaxWidth, andMaxHeight:-
Content:
HorizontalOffsetandVerticalOffsetvalues are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition,MaxWidthandMaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. -
Frame:
HorizontalOffsetandVerticalOffsetvalues are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition,MaxWidthandMaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.
- VerticalAlign
-
- Type: string
The vertical position of the watermark unless you specify a non-zero value for
VerticalOffset:-
Top: The top edge of the watermark is aligned with the top border of the video.
-
Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.
-
Center: The watermark is centered between the top and bottom borders.
- VerticalOffset
-
- Type: string
VerticalOffsetThe amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
-
number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of
MaxHeight. -
integer percentage (%): The range of valid values is 0 to 100.
For example, if you specify
TopforVerticalAlignand5pxforVerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.VerticalOffsetis only valid when the value of VerticalAlign is Top or Bottom.If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of
Targetto specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.
ResourceInUseException
Description
The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.
Members
ResourceNotFoundException
Description
The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.
Members
Thumbnails
Description
Thumbnails for videos.
Members
- AspectRatio
-
- Type: string
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The aspect ratio of thumbnails. Valid values include:
auto,1:1,4:3,3:2,16:9If you specify
auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file. - Format
-
- Type: string
The format of thumbnails, if any. Valid values are
jpgandpng.You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
- Interval
-
- Type: string
The approximate number of seconds between thumbnails. Specify an integer value.
- MaxHeight
-
- Type: string
The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.
- MaxWidth
-
- Type: string
The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.
- PaddingPolicy
-
- Type: string
When you set
PaddingPolicytoPad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnailMaxWidthandMaxHeightsettings. - Resolution
-
- Type: string
To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy, andPaddingPolicyinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The width and height of thumbnail files in pixels. Specify a value in the format
widthxheightwhere both values are even integers. The values cannot exceed the width and height that you specified in theVideo:Resolutionobject. - SizingPolicy
-
- Type: string
Specify one of the following values to control scaling of thumbnails:
-
Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value. -
Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnailMaxWidthorMaxHeightsettings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value. -
Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnailMaxWidthandMaxHeightsettings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted. -
Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnailMaxWidthandMaxHeightsettings, Elastic Transcoder crops the thumbnails. -
ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnailMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up. -
ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
TimeSpan
Description
Settings that determine when a clip begins and how long it lasts.
Members
- Duration
-
- Type: string
The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
- StartTime
-
- Type: string
The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.
Timing
Description
Details about the timing of a job.
Members
- FinishTimeMillis
-
- Type: long (int|float)
The time the job finished transcoding, in epoch milliseconds.
- StartTimeMillis
-
- Type: long (int|float)
The time the job began transcoding, in epoch milliseconds.
- SubmitTimeMillis
-
- Type: long (int|float)
The time the job was submitted to Elastic Transcoder, in epoch milliseconds.
ValidationException
Description
One or more required parameter values were not provided in the request.
Members
VideoParameters
Description
The VideoParameters structure.
Members
- AspectRatio
-
- Type: string
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy,PaddingPolicy, andDisplayAspectRatioinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The display aspect ratio of the video in the output file. Valid values include:
auto,1:1,4:3,3:2,16:9If you specify
auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
- BitRate
-
- Type: string
The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of
LevelandProfile. If you specifyauto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other thanauto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
-
1 - 64 : 80
-
1b - 128 : 160
-
1.1 - 192 : 240
-
1.2 - 384 : 480
-
1.3 - 768 : 960
-
2 - 2000 : 2500
-
3 - 10000 : 12500
-
3.1 - 14000 : 17500
-
3.2 - 20000 : 25000
-
4 - 20000 : 25000
-
4.1 - 50000 : 62500
- Codec
-
- Type: string
The video codec for the output file. Valid values include
gif,H.264,mpeg2,vp8, andvp9. You can only specifyvp8andvp9when the container type iswebm,gifwhen the container type isgif, andmpeg2when the container type ismpg. - CodecOptions
-
- Type: Associative array of custom strings keys (CodecOption) to strings
Profile (H.264/VP8/VP9 Only)
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
-
baseline: The profile most commonly used for videoconferencing and for mobile applications. -
main: The profile used for standard-definition digital TV broadcasts. -
high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.
Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1,1b,1.1,1.2,1.3,2,2.1,2.2,3,3.1,3.2,4,4.1MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the
Levelobject. See the list below. (A macroblock is a block of pixels measuring 16x16.)-
1 - 396
-
1b - 396
-
1.1 - 900
-
1.2 - 2376
-
1.3 - 2376
-
2 - 2376
-
2.1 - 4752
-
2.2 - 8100
-
3 - 8100
-
3.1 - 18000
-
3.2 - 20480
-
4 - 32768
-
4.1 - 32768
MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits per second in a video buffer; the size of the buffer is specified by
BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)
The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify
MaxBitRateand omitBufferSize, Elastic Transcoder setsBufferSizeto 10 times the value ofMaxBitRate.InterlacedMode (Optional, H.264/MPEG2 Only)
The interlace mode for the output video.
Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.
Valid values include
Progressive(no interlacing, top to bottom),TopFirst(top field first),BottomFirst(bottom field first), andAuto.If
InterlaceModeis not specified, Elastic Transcoder usesProgressivefor the output. IfAutois specified, Elastic Transcoder interlaces the output.ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color.
Bt.601is the standard for standard definition video, whileBt.709is the standard for high definition video.Valid values include
None,Bt709toBt601,Bt601toBt709, andAuto.If you chose
AutoforColorSpaceConversionModeand your output is interlaced, your frame rate is one of23.97,24,25,29.97,50, or60, yourSegmentDurationis null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:-
Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709 -
Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies
Bt601ToBt709 -
HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies
Bt709ToBt601 -
HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies
Bt709ToBt601
Elastic Transcoder may change the behavior of the
ColorspaceConversionModeAutomode in the future. All outputs in a playlist must use the sameColorSpaceConversionMode.If you do not specify a
ColorSpaceConversionMode, Elastic Transcoder does not change the color space of a file. If you are unsure whatColorSpaceConversionModewas applied to your output file, you can check theAppliedColorSpaceConversionparameter included in your job response. If your job does not have anAppliedColorSpaceConversionin its response, noColorSpaceConversionModewas applied.ChromaSubsampling
The sampling pattern for the chroma (color) channels of the output video. Valid values include
yuv420pandyuv422p.yuv420psamples the chroma information of every other horizontal and every other vertical line,yuv422psamples the color information of every horizontal line and every other vertical line.LoopCount (Gif Only)
The number of times you want the output gif to loop. Valid values include
Infiniteand integers between0and100, inclusive. - DisplayAspectRatio
-
- Type: string
The value that Elastic Transcoder adds to the metadata in the output file.
- FixedGOP
-
- Type: string
Applicable only when the value of Video:Codec is one of
H.264,MPEG2, orVP8.Whether to use a fixed value for
FixedGOP. Valid values aretrueandfalse:-
true: Elastic Transcoder uses the value ofKeyframesMaxDistfor the distance between key frames (the number of frames in a group of pictures, or GOP). -
false: The distance between key frames can vary.
FixedGOPmust be set totrueforfmp4containers. - FrameRate
-
- Type: string
The frames per second for the video stream in the output file. Valid values include:
auto,10,15,23.97,24,25,29.97,30,60If you specify
auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)where:
-
width in pixels and height in pixels represent the Resolution of the output video.
-
maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
-
1 - 380160
-
1b - 380160
-
1.1 - 76800
-
1.2 - 1536000
-
1.3 - 3041280
-
2 - 3041280
-
2.1 - 5068800
-
2.2 - 5184000
-
3 - 10368000
-
3.1 - 27648000
-
3.2 - 55296000
-
4 - 62914560
-
4.1 - 62914560
- KeyframesMaxDist
-
- Type: string
Applicable only when the value of Video:Codec is one of
H.264,MPEG2, orVP8.The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.
For
Smoothoutputs, theFrameRatemust have a constant ratio to theKeyframesMaxDist. This allowsSmoothplaylists to switch between different quality levels while the file is being played.For example, an input file can have a
FrameRateof 30 with aKeyframesMaxDistof 90. The output file then needs to have a ratio of 1:3. Valid outputs would haveFrameRateof 30, 25, and 10, andKeyframesMaxDistof 90, 75, and 30, respectively.Alternately, this can be achieved by setting
FrameRateto auto and having the same values forMaxFrameRateandKeyframesMaxDist. - MaxFrameRate
-
- Type: string
If you specify
autoforFrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include:10,15,23.97,24,25,29.97,30,60. - MaxHeight
-
- Type: string
The maximum height of the output video in pixels. If you specify
auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072. - MaxWidth
-
- Type: string
The maximum width of the output video in pixels. If you specify
auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096. - PaddingPolicy
-
- Type: string
When you set
PaddingPolicytoPad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified forMaxWidthandMaxHeight. - Resolution
-
- Type: string
To better control resolution and aspect ratio of output videos, we recommend that you use the values
MaxWidth,MaxHeight,SizingPolicy,PaddingPolicy, andDisplayAspectRatioinstead ofResolutionandAspectRatio. The two groups of settings are mutually exclusive. Do not use them together.The width and height of the video in the output file, in pixels. Valid values are
autoand width x height:-
auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules. -
width x height: The width and height of the output video in pixels.
Note the following about specifying the width and height:
-
The width must be an even integer between 128 and 4096, inclusive.
-
The height must be an even integer between 96 and 3072, inclusive.
-
If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.
-
If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.
-
We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):
-
1 - 25344
-
1b - 25344
-
1.1 - 101376
-
1.2 - 101376
-
1.3 - 101376
-
2 - 101376
-
2.1 - 202752
-
2.2 - 404720
-
3 - 404720
-
3.1 - 921600
-
3.2 - 1310720
-
4 - 2097152
-
4.1 - 2097152
-
- SizingPolicy
-
- Type: string
Specify one of the following values to control scaling of the output video:
-
Fit: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidthorMaxHeightwithout exceeding the other value. -
Fill: Elastic Transcoder scales the output video so it matches the value that you specified in eitherMaxWidthorMaxHeightand matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value. -
Stretch: Elastic Transcoder stretches the output video to match the values that you specified forMaxWidthandMaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted. -
Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified forMaxWidthandMaxHeight, Elastic Transcoder crops the output video. -
ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up. -
ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one ofMaxWidthandMaxHeightwithout dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.
- Watermarks
-
- Type: Array of PresetWatermark structures
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.
Warning
Description
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.
Members
- Code
-
- Type: string
The code of the cross-regional warning.
- Message
-
- Type: string
The message explaining what resources are in a different region from the pipeline.
AWS KMS keys must be in the same region as the pipeline.