AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing ElasticTranscoder AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

Inheritance Hierarchy

Amazon.ElasticTranscoder.IAmazonElasticTranscoder

Namespace: Amazon.ElasticTranscoder
Assembly: AWSSDK.ElasticTranscoder.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonElasticTranscoder
         IAmazonService, IDisposable

The IAmazonElasticTranscoder type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelJob(CancelJobRequest)

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJob operation.

Public Method CreateJob(CreateJobRequest)

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

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJob operation.

Public Method CreatePipeline(CreatePipelineRequest)

The CreatePipeline operation creates a pipeline with settings that you specify.

Public Method CreatePipelineAsync(CreatePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePipeline operation.

Public Method CreatePreset(CreatePresetRequest)

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.

Public Method CreatePresetAsync(CreatePresetRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePreset operation.

Public Method DeletePipeline(DeletePipelineRequest)

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.

Public Method DeletePipelineAsync(DeletePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePipeline operation.

Public Method DeletePreset(DeletePresetRequest)

The DeletePreset operation removes a preset that you've added in an AWS region.

You can't delete the default presets that are included with Elastic Transcoder.

Public Method DeletePresetAsync(DeletePresetRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePreset operation.

Public Method ListJobsByPipeline(ListJobsByPipelineRequest)

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.

Public Method ListJobsByPipelineAsync(ListJobsByPipelineRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobsByPipeline operation.

Public Method ListJobsByStatus(ListJobsByStatusRequest)

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.

Public Method ListJobsByStatusAsync(ListJobsByStatusRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobsByStatus operation.

Public Method ListPipelines()

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

Public Method ListPipelines(ListPipelinesRequest)

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

Public Method ListPipelinesAsync(CancellationToken)

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

Public Method ListPipelinesAsync(ListPipelinesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPipelines operation.

Public Method ListPresets()

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.

Public Method ListPresets(ListPresetsRequest)

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.

Public Method ListPresetsAsync(CancellationToken)

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.

Public Method ListPresetsAsync(ListPresetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPresets operation.

Public Method ReadJob(ReadJobRequest)

The ReadJob operation returns detailed information about a job.

Public Method ReadJobAsync(ReadJobRequest, CancellationToken)

Initiates the asynchronous execution of the ReadJob operation.

Public Method ReadPipeline(ReadPipelineRequest)

The ReadPipeline operation gets detailed information about a pipeline.

Public Method ReadPipelineAsync(ReadPipelineRequest, CancellationToken)

Initiates the asynchronous execution of the ReadPipeline operation.

Public Method ReadPreset(ReadPresetRequest)

The ReadPreset operation gets detailed information about a preset.

Public Method ReadPresetAsync(ReadPresetRequest, CancellationToken)

Initiates the asynchronous execution of the ReadPreset operation.

Public Method TestRole(TestRoleRequest)

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.

Public Method TestRoleAsync(TestRoleRequest, CancellationToken)

Initiates the asynchronous execution of the TestRole operation.

Public Method UpdatePipeline(UpdatePipelineRequest)

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.

Public Method UpdatePipelineAsync(UpdatePipelineRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePipeline operation.

Public Method UpdatePipelineNotifications(UpdatePipelineNotificationsRequest)

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.

Public Method UpdatePipelineNotificationsAsync(UpdatePipelineNotificationsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePipelineNotifications operation.

Public Method UpdatePipelineStatus(UpdatePipelineStatusRequest)

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.

Public Method UpdatePipelineStatusAsync(UpdatePipelineStatusRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePipelineStatus operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms