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.

Implementation for accessing MediaConvert AWS Elemental MediaConvert

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.MediaConvert.AmazonMediaConvertClient

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

Syntax

C#
public class AmazonMediaConvertClient : AmazonServiceClient
         IAmazonMediaConvert, IAmazonService, IDisposable

The AmazonMediaConvertClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMediaConvertClient()

Constructs AmazonMediaConvertClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMediaConvertClient(RegionEndpoint)

Constructs AmazonMediaConvertClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMediaConvertClient(AmazonMediaConvertConfig)

Constructs AmazonMediaConvertClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonMediaConvertClient(AWSCredentials)

Constructs AmazonMediaConvertClient with AWS Credentials

Public Method AmazonMediaConvertClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMediaConvertClient with AWS Credentials

Public Method AmazonMediaConvertClient(AWSCredentials, AmazonMediaConvertConfig)

Constructs AmazonMediaConvertClient with AWS Credentials and an AmazonMediaConvertClient Configuration object.

Public Method AmazonMediaConvertClient(string, string)

Constructs AmazonMediaConvertClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMediaConvertClient(string, string, RegionEndpoint)

Constructs AmazonMediaConvertClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMediaConvertClient(string, string, AmazonMediaConvertConfig)

Constructs AmazonMediaConvertClient with AWS Access Key ID, AWS Secret Key and an AmazonMediaConvertClient Configuration object.

Public Method AmazonMediaConvertClient(string, string, string)

Constructs AmazonMediaConvertClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMediaConvertClient(string, string, string, RegionEndpoint)

Constructs AmazonMediaConvertClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMediaConvertClient(string, string, string, AmazonMediaConvertConfig)

Constructs AmazonMediaConvertClient with AWS Access Key ID, AWS Secret Key and an AmazonMediaConvertClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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)

Permanently remove a job from a queue. Once you have canceled a job, you can't start it again. You can't delete a running job.

Public Method CancelJobAsync(CancelJobRequest, CancellationToken)

Initiates the asynchronous execution of the CancelJob operation.

Public Method CreateJob(CreateJobRequest)

Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method CreateJobAsync(CreateJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJob operation.

Public Method CreateJobTemplate(CreateJobTemplateRequest)

Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method CreateJobTemplateAsync(CreateJobTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the CreateJobTemplate operation.

Public Method CreatePreset(CreatePresetRequest)

Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method CreatePresetAsync(CreatePresetRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePreset operation.

Public Method CreateQueue(CreateQueueRequest)

Create a new transcoding queue. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method CreateQueueAsync(CreateQueueRequest, CancellationToken)

Initiates the asynchronous execution of the CreateQueue operation.

Public Method DeleteJobTemplate(DeleteJobTemplateRequest)

Permanently delete a job template you have created.

Public Method DeleteJobTemplateAsync(DeleteJobTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteJobTemplate operation.

Public Method DeletePreset(DeletePresetRequest)

Permanently delete a preset you have created.

Public Method DeletePresetAsync(DeletePresetRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePreset operation.

Public Method DeleteQueue(DeleteQueueRequest)

Permanently delete a queue you have created.

Public Method DeleteQueueAsync(DeleteQueueRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteQueue operation.

Public Method DescribeEndpoints(DescribeEndpointsRequest)

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

Public Method DescribeEndpointsAsync(DescribeEndpointsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeEndpoints operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetJob(GetJobRequest)

Retrieve the JSON for a specific completed transcoding job.

Public Method GetJobAsync(GetJobRequest, CancellationToken)

Initiates the asynchronous execution of the GetJob operation.

Public Method GetJobTemplate(GetJobTemplateRequest)

Retrieve the JSON for a specific job template.

Public Method GetJobTemplateAsync(GetJobTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the GetJobTemplate operation.

Public Method GetPreset(GetPresetRequest)

Retrieve the JSON for a specific preset.

Public Method GetPresetAsync(GetPresetRequest, CancellationToken)

Initiates the asynchronous execution of the GetPreset operation.

Public Method GetQueue(GetQueueRequest)

Retrieve the JSON for a specific queue.

Public Method GetQueueAsync(GetQueueRequest, CancellationToken)

Initiates the asynchronous execution of the GetQueue operation.

Public Method ListJobs(ListJobsRequest)

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

Public Method ListJobsAsync(ListJobsRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobs operation.

Public Method ListJobTemplates(ListJobTemplatesRequest)

Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array

Public Method ListJobTemplatesAsync(ListJobTemplatesRequest, CancellationToken)

Initiates the asynchronous execution of the ListJobTemplates operation.

Public Method ListPresets(ListPresetsRequest)

Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

Public Method ListPresetsAsync(ListPresetsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPresets operation.

Public Method ListQueues(ListQueuesRequest)

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

Public Method ListQueuesAsync(ListQueuesRequest, CancellationToken)

Initiates the asynchronous execution of the ListQueues operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieve the tags for a MediaConvert resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method TagResource(TagResourceRequest)

Tag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

Untag a MediaConvert queue, preset, or job template. For information about these resource types, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Public Method UpdateJobTemplate(UpdateJobTemplateRequest)

Modify one of your existing job templates.

Public Method UpdateJobTemplateAsync(UpdateJobTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateJobTemplate operation.

Public Method UpdatePreset(UpdatePresetRequest)

Modify one of your existing presets.

Public Method UpdatePresetAsync(UpdatePresetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePreset operation.

Public Method UpdateQueue(UpdateQueueRequest)

Modify one of your existing queues.

Public Method UpdateQueueAsync(UpdateQueueRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateQueue operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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