AWS.ElasticTranscoder — AWS SDK for JavaScript (original) (raw)

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

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();

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 Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

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.

Property Details

endpoint ⇒ AWS.Endpoint

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

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. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

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). If the pipeline is currently in use, DeletePipeline returns an error.

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. The response body contains one element for each job that satisfies the search criteria.

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

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

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. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

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. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

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. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

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

Waits for a given ElasticTranscoder resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Waiter Resource Details

elastictranscoder.waitFor('jobComplete', params = {}, [callback]) ⇒ AWS.Request

Waits for the jobComplete state by periodically calling the underlyingElasticTranscoder.readJob() operation every 30 seconds (at most 120 times).