The AWS SDK for JavaScript v2 has reached end-of-support.

We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.ElasticTranscoder

Inherits:

AWS.Service

Object
AWS.Service
AWS.ElasticTranscoder

show all

Identifier:: elastictranscoder

API Version:: 2012-09-25

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The AWS Elastic Transcoder Service.

Sending a Request Using ElasticTranscoder

var elastictranscoder = new AWS.ElasticTranscoder();
elastictranscoder.cancelJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ElasticTranscoder object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var elastictranscoder = new AWS.ElasticTranscoder({apiVersion: '2012-09-25'});

You can also set the API version globally in AWS.config.apiVersions using the elastictranscoder service identifier:

AWS.config.apiVersions = {
  elastictranscoder: '2012-09-25',
  // other service API versions
};

var elastictranscoder = new AWS.ElasticTranscoder();

Version:

2012-09-25

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

jobComplete

Constructor Summary collapse

new AWS.ElasticTranscoder(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

cancelJob(params = {}, callback) ⇒ AWS.Request
The CancelJob operation cancels an unfinished job.

Note: You can only cancel a job that has a status of Submitted.
createJob(params = {}, callback) ⇒ AWS.Request
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).
.
createPipeline(params = {}, callback) ⇒ AWS.Request
The CreatePipeline operation creates a pipeline with settings that you specify.

.
createPreset(params = {}, callback) ⇒ AWS.Request
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.
deletePipeline(params = {}, callback) ⇒ AWS.Request
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).
deletePreset(params = {}, callback) ⇒ AWS.Request
The DeletePreset operation removes a preset that you've added in an AWS region.

Note: You can't delete the default presets that are included with Elastic Transcoder.
listJobsByPipeline(params = {}, callback) ⇒ AWS.Request
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.
listJobsByStatus(params = {}, callback) ⇒ AWS.Request
The ListJobsByStatus operation gets a list of jobs that have a specified status.
listPipelines(params = {}, callback) ⇒ AWS.Request
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

.
listPresets(params = {}, callback) ⇒ AWS.Request
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(params = {}, callback) ⇒ AWS.Request
The ReadJob operation returns detailed information about a job.

.
readPipeline(params = {}, callback) ⇒ AWS.Request
The ReadPipeline operation gets detailed information about a pipeline.

.
readPreset(params = {}, callback) ⇒ AWS.Request
The ReadPreset operation gets detailed information about a preset.

.
testRole(params = {}, callback) ⇒ AWS.Request
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.
updatePipeline(params = {}, callback) ⇒ AWS.Request
Use the UpdatePipeline operation to update settings for a pipeline.

When you change pipeline settings, your changes take effect immediately.
updatePipelineNotifications(params = {}, callback) ⇒ AWS.Request
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.
.
updatePipelineStatus(params = {}, callback) ⇒ AWS.Request
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.
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given ElasticTranscoder resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ElasticTranscoder(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ElasticTranscoder object

var elastictranscoder = new AWS.ElasticTranscoder({apiVersion: '2012-09-25'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.ElasticTranscoder.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.ElasticTranscoder.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.ElasticTranscoder.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelJob(params = {}, callback) ⇒ `AWS.Request`

The CancelJob operation cancels an unfinished job.

Note: 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.

Service Reference:

CancelJob

Examples:

Calling the cancelJob operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
elastictranscoder.cancelJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Id — (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 of Submitted, use the ListJobsByStatus API action.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createJob(params = {}, callback) ⇒ `AWS.Request`

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).

Service Reference:

CreateJob

Examples:

Calling the createJob operation

var params = {
  PipelineId: 'STRING_VALUE', /* required */
  Input: {
    AspectRatio: 'STRING_VALUE',
    Container: 'STRING_VALUE',
    DetectedProperties: {
      DurationMillis: 'NUMBER_VALUE',
      FileSize: 'NUMBER_VALUE',
      FrameRate: 'STRING_VALUE',
      Height: 'NUMBER_VALUE',
      Width: 'NUMBER_VALUE'
    },
    Encryption: {
      InitializationVector: 'STRING_VALUE',
      Key: 'STRING_VALUE',
      KeyMd5: 'STRING_VALUE',
      Mode: 'STRING_VALUE'
    },
    FrameRate: 'STRING_VALUE',
    InputCaptions: {
      CaptionSources: [
        {
          Encryption: {
            InitializationVector: 'STRING_VALUE',
            Key: 'STRING_VALUE',
            KeyMd5: 'STRING_VALUE',
            Mode: 'STRING_VALUE'
          },
          Key: 'STRING_VALUE',
          Label: 'STRING_VALUE',
          Language: 'STRING_VALUE',
          TimeOffset: 'STRING_VALUE'
        },
        /* more items */
      ],
      MergePolicy: 'STRING_VALUE'
    },
    Interlaced: 'STRING_VALUE',
    Key: 'STRING_VALUE',
    Resolution: 'STRING_VALUE',
    TimeSpan: {
      Duration: 'STRING_VALUE',
      StartTime: 'STRING_VALUE'
    }
  },
  Inputs: [
    {
      AspectRatio: 'STRING_VALUE',
      Container: 'STRING_VALUE',
      DetectedProperties: {
        DurationMillis: 'NUMBER_VALUE',
        FileSize: 'NUMBER_VALUE',
        FrameRate: 'STRING_VALUE',
        Height: 'NUMBER_VALUE',
        Width: 'NUMBER_VALUE'
      },
      Encryption: {
        InitializationVector: 'STRING_VALUE',
        Key: 'STRING_VALUE',
        KeyMd5: 'STRING_VALUE',
        Mode: 'STRING_VALUE'
      },
      FrameRate: 'STRING_VALUE',
      InputCaptions: {
        CaptionSources: [
          {
            Encryption: {
              InitializationVector: 'STRING_VALUE',
              Key: 'STRING_VALUE',
              KeyMd5: 'STRING_VALUE',
              Mode: 'STRING_VALUE'
            },
            Key: 'STRING_VALUE',
            Label: 'STRING_VALUE',
            Language: 'STRING_VALUE',
            TimeOffset: 'STRING_VALUE'
          },
          /* more items */
        ],
        MergePolicy: 'STRING_VALUE'
      },
      Interlaced: 'STRING_VALUE',
      Key: 'STRING_VALUE',
      Resolution: 'STRING_VALUE',
      TimeSpan: {
        Duration: 'STRING_VALUE',
        StartTime: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  Output: {
    AlbumArt: {
      Artwork: [
        {
          AlbumArtFormat: 'STRING_VALUE',
          Encryption: {
            InitializationVector: 'STRING_VALUE',
            Key: 'STRING_VALUE',
            KeyMd5: 'STRING_VALUE',
            Mode: 'STRING_VALUE'
          },
          InputKey: 'STRING_VALUE',
          MaxHeight: 'STRING_VALUE',
          MaxWidth: 'STRING_VALUE',
          PaddingPolicy: 'STRING_VALUE',
          SizingPolicy: 'STRING_VALUE'
        },
        /* more items */
      ],
      MergePolicy: 'STRING_VALUE'
    },
    Captions: {
      CaptionFormats: [
        {
          Encryption: {
            InitializationVector: 'STRING_VALUE',
            Key: 'STRING_VALUE',
            KeyMd5: 'STRING_VALUE',
            Mode: 'STRING_VALUE'
          },
          Format: 'STRING_VALUE',
          Pattern: 'STRING_VALUE'
        },
        /* more items */
      ],
      CaptionSources: [
        {
          Encryption: {
            InitializationVector: 'STRING_VALUE',
            Key: 'STRING_VALUE',
            KeyMd5: 'STRING_VALUE',
            Mode: 'STRING_VALUE'
          },
          Key: 'STRING_VALUE',
          Label: 'STRING_VALUE',
          Language: 'STRING_VALUE',
          TimeOffset: 'STRING_VALUE'
        },
        /* more items */
      ],
      MergePolicy: 'STRING_VALUE'
    },
    Composition: [
      {
        TimeSpan: {
          Duration: 'STRING_VALUE',
          StartTime: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    Encryption: {
      InitializationVector: 'STRING_VALUE',
      Key: 'STRING_VALUE',
      KeyMd5: 'STRING_VALUE',
      Mode: 'STRING_VALUE'
    },
    Key: 'STRING_VALUE',
    PresetId: 'STRING_VALUE',
    Rotate: 'STRING_VALUE',
    SegmentDuration: 'STRING_VALUE',
    ThumbnailEncryption: {
      InitializationVector: 'STRING_VALUE',
      Key: 'STRING_VALUE',
      KeyMd5: 'STRING_VALUE',
      Mode: 'STRING_VALUE'
    },
    ThumbnailPattern: 'STRING_VALUE',
    Watermarks: [
      {
        Encryption: {
          InitializationVector: 'STRING_VALUE',
          Key: 'STRING_VALUE',
          KeyMd5: 'STRING_VALUE',
          Mode: 'STRING_VALUE'
        },
        InputKey: 'STRING_VALUE',
        PresetWatermarkId: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  OutputKeyPrefix: 'STRING_VALUE',
  Outputs: [
    {
      AlbumArt: {
        Artwork: [
          {
            AlbumArtFormat: 'STRING_VALUE',
            Encryption: {
              InitializationVector: 'STRING_VALUE',
              Key: 'STRING_VALUE',
              KeyMd5: 'STRING_VALUE',
              Mode: 'STRING_VALUE'
            },
            InputKey: 'STRING_VALUE',
            MaxHeight: 'STRING_VALUE',
            MaxWidth: 'STRING_VALUE',
            PaddingPolicy: 'STRING_VALUE',
            SizingPolicy: 'STRING_VALUE'
          },
          /* more items */
        ],
        MergePolicy: 'STRING_VALUE'
      },
      Captions: {
        CaptionFormats: [
          {
            Encryption: {
              InitializationVector: 'STRING_VALUE',
              Key: 'STRING_VALUE',
              KeyMd5: 'STRING_VALUE',
              Mode: 'STRING_VALUE'
            },
            Format: 'STRING_VALUE',
            Pattern: 'STRING_VALUE'
          },
          /* more items */
        ],
        CaptionSources: [
          {
            Encryption: {
              InitializationVector: 'STRING_VALUE',
              Key: 'STRING_VALUE',
              KeyMd5: 'STRING_VALUE',
              Mode: 'STRING_VALUE'
            },
            Key: 'STRING_VALUE',
            Label: 'STRING_VALUE',
            Language: 'STRING_VALUE',
            TimeOffset: 'STRING_VALUE'
          },
          /* more items */
        ],
        MergePolicy: 'STRING_VALUE'
      },
      Composition: [
        {
          TimeSpan: {
            Duration: 'STRING_VALUE',
            StartTime: 'STRING_VALUE'
          }
        },
        /* more items */
      ],
      Encryption: {
        InitializationVector: 'STRING_VALUE',
        Key: 'STRING_VALUE',
        KeyMd5: 'STRING_VALUE',
        Mode: 'STRING_VALUE'
      },
      Key: 'STRING_VALUE',
      PresetId: 'STRING_VALUE',
      Rotate: 'STRING_VALUE',
      SegmentDuration: 'STRING_VALUE',
      ThumbnailEncryption: {
        InitializationVector: 'STRING_VALUE',
        Key: 'STRING_VALUE',
        KeyMd5: 'STRING_VALUE',
        Mode: 'STRING_VALUE'
      },
      ThumbnailPattern: 'STRING_VALUE',
      Watermarks: [
        {
          Encryption: {
            InitializationVector: 'STRING_VALUE',
            Key: 'STRING_VALUE',
            KeyMd5: 'STRING_VALUE',
            Mode: 'STRING_VALUE'
          },
          InputKey: 'STRING_VALUE',
          PresetWatermarkId: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  Playlists: [
    {
      Format: 'STRING_VALUE',
      HlsContentProtection: {
        InitializationVector: 'STRING_VALUE',
        Key: 'STRING_VALUE',
        KeyMd5: 'STRING_VALUE',
        KeyStoragePolicy: 'STRING_VALUE',
        LicenseAcquisitionUrl: 'STRING_VALUE',
        Method: 'STRING_VALUE'
      },
      Name: 'STRING_VALUE',
      OutputKeys: [
        'STRING_VALUE',
        /* more items */
      ],
      PlayReadyDrm: {
        Format: 'STRING_VALUE',
        InitializationVector: 'STRING_VALUE',
        Key: 'STRING_VALUE',
        KeyId: 'STRING_VALUE',
        KeyMd5: 'STRING_VALUE',
        LicenseAcquisitionUrl: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  UserMetadata: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
elastictranscoder.createJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PipelineId — (String)
  The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
- Input — (map)
  A section of the request body that provides information about the file that is being transcoded.
  - Key — (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 InputBucket object 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.
  - FrameRate — (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, 60
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.
  - Resolution — (String)
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
  - AspectRatio — (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:9
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.
  - Interlaced — (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, false
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.
  - Container — (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
  - Encryption — (map)
    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.
    - Mode — (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-kms and 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.
    - Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
    - KeyMd5 — (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.
    - InitializationVector — (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.
  - TimeSpan — (map)
    Settings for clipping an input. Each input can have different clip settings.
    - StartTime — (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.
    - Duration — (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.
  - InputCaptions — (map)
    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), and mov-text
      
      Valid outputs include: mov-text
      
      Elastic 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), and webvtt
      
      Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
    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 Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
    
    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.
    - MergePolicy — (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 CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
      
      Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
      
      MergePolicy cannot be null.
    - CaptionSources — (Array<map>)
      Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
      
      Key — (String)
      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
      
      Language — (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 — (String)
      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells 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.
      
      Label — (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.
      
      Encryption — (map)
      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.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - DetectedProperties — (map)
    The detected properties of the input file.
    - Width — (Integer)
      The detected width of the input file, in pixels.
    - Height — (Integer)
      The detected height of the input file, in pixels.
    - FrameRate — (String)
      The detected frame rate of the input file, in frames per second.
    - FileSize — (Integer)
      The detected file size of the input file, in bytes.
    - DurationMillis — (Integer)
      The detected duration of the input file, in milliseconds.
- Inputs — (Array<map>)
  A section of the request body that provides information about the files that are being transcoded.
  - Key — (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 InputBucket object 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.
  - FrameRate — (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, 60
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.
  - Resolution — (String)
    This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
  - AspectRatio — (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:9
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.
  - Interlaced — (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, false
    
    If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.
  - Container — (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
  - Encryption — (map)
    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.
    - Mode — (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-kms and 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.
    - Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
    - KeyMd5 — (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.
    - InitializationVector — (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.
  - TimeSpan — (map)
    Settings for clipping an input. Each input can have different clip settings.
    - StartTime — (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.
    - Duration — (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.
  - InputCaptions — (map)
    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), and mov-text
      
      Valid outputs include: mov-text
      
      Elastic 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), and webvtt
      
      Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
    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 Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
    
    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.
    - MergePolicy — (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 CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
      
      Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
      
      MergePolicy cannot be null.
    - CaptionSources — (Array<map>)
      Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
      
      Key — (String)
      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
      
      Language — (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 — (String)
      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells 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.
      
      Label — (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.
      
      Encryption — (map)
      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.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - DetectedProperties — (map)
    The detected properties of the input file.
    - Width — (Integer)
      The detected width of the input file, in pixels.
    - Height — (Integer)
      The detected height of the input file, in pixels.
    - FrameRate — (String)
      The detected frame rate of the input file, in frames per second.
    - FileSize — (Integer)
      The detected file size of the input file, in bytes.
    - DurationMillis — (Integer)
      The detected duration of the input file, in milliseconds.
- Output — (map)
  A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.
  - Key — (String)
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
  - ThumbnailPattern — (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 the ThumbnailPattern object. 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 ThumbnailPattern object. 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 the ThumbnailPattern object.
    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 PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
  - ThumbnailEncryption — (map)
    The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
    - Mode — (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-kms and 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.
    - Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
    - KeyMd5 — (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.
    - InitializationVector — (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.
  - Rotate — (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 value auto generally works only if the file that you're transcoding contains rotation metadata.
  - PresetId — (String)
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
  - SegmentDuration — (String)
    (Outputs in Fragmented MP4 or MPEG-TS format only.
    
    If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, 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 HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.
  - Watermarks — (Array<map>)
    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.
    - PresetWatermarkId — (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.
    - InputKey — (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; the Input Bucket object 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.
    - Encryption — (map)
      The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - AlbumArt — (map)
    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.
    - MergePolicy — (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.
    - Artwork — (Array<map>)
      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 .jpg and .png
      
      InputKey — (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; the InputBucket object 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.
      
      MaxWidth — (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.
      
      MaxHeight — (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.
      
      SizingPolicy — (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 either MaxWidth or MaxHeight without exceeding the other value.
      
      Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and 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 for MaxWidth and MaxHeight. 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 for MaxWidth and MaxHeight, 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 of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.
      
      ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
      
      PaddingPolicy — (String)
      When you set PaddingPolicy to Pad, 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 for MaxWidth and MaxHeight.
      
      AlbumArtFormat — (String)
      The format of album art, if any. Valid formats are .jpg and .png.
      
      Encryption — (map)
      The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - Composition — (Array<map>)
    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.
    - TimeSpan — (map)
      Settings that determine when a clip begins and how long it lasts.
      
      StartTime — (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.
      
      Duration — (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.
  - Captions — (map)
    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), and mov-text
      
      Valid outputs include: mov-text
      
      Elastic 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), and webvtt
      
      Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
    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 Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
    
    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.
    - MergePolicy — (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 CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
      
      Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.
      
      MergePolicy cannot be null.
    - CaptionSources — (Array<map>)
      Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.
      
      Key — (String)
      The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
      
      Language — (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 — (String)
      For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells 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.
      
      Label — (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.
      
      Encryption — (map)
      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.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
    - CaptionFormats — (Array<map>)
      The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.
      
      Format — (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
      
      fmp4 captions have an extension of .ismt
      
      Pattern — (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.
      
      Encryption — (map)
      The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - Encryption — (map)
    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.
    - Mode — (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-kms and 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.
    - Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
    - KeyMd5 — (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.
    - InitializationVector — (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.
- Outputs — (Array<map>)
  A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
  - Key — (String)
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
  - ThumbnailPattern — (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 the ThumbnailPattern object. 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 ThumbnailPattern object. 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 the ThumbnailPattern object.
    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 PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
  - ThumbnailEncryption — (map)
    The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
    - Mode — (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-kms and 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.
    - Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
    - KeyMd5 — (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.
    - InitializationVector — (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.
  - Rotate — (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 value auto generally works only if the file that you're transcoding contains rotation metadata.
  - PresetId — (String)
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
  - SegmentDuration — (String)
    (Outputs in Fragmented MP4 or MPEG-TS format only.
    
    If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, 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 HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.
  - Watermarks — (Array<map>)
    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.
    - PresetWatermarkId — (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.
    - InputKey — (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; the Input Bucket object 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.
    - Encryption — (map)
      The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
      
      Mode — (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-kms and 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.
      
      Key — (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, or 256.
      
      The key must also be encrypted by using the Amazon Key Management Service.
      
      KeyMd5 — (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.
      
      InitializationVector — (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.
  - AlbumArt — (map)
    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.
    - MergePolicy — (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.
    - Artwork — (Array<map>)
      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 .jpg and .png
      
      InputKey — (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; the InputBucket object 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.
      
      MaxWidth — (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.
      
      MaxHeight — (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.
      
      SizingPolicy — (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 either MaxWidth or MaxHeight without exceeding the other value.
      
      Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and 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 for MaxWidth and MaxHeight. 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 for MaxWidth and MaxHeight, 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 of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.
      
      ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.
      
      PaddingPolicy — (String)
      When you set PaddingPolicy to Pad, 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 for MaxWidth and MaxHeight.
      
      AlbumArtFormat — (String)
      The format of album art, if any. Valid formats are .jpg and .png.
      
      Encryption — (map)
      The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
      
      Mode — (

Class: AWS.ElasticTranscoder

Overview

Service Description

Sending a Request Using ElasticTranscoder

Locking the API Version

Waiter Resource States

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.ElasticTranscoder(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

cancelJob(params = {}, callback) ⇒ AWS.Request

createJob(params = {}, callback) ⇒ AWS.Request

new AWS.ElasticTranscoder(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

cancelJob(params = {}, callback) ⇒ `AWS.Request`

createJob(params = {}, callback) ⇒ `AWS.Request`