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.

Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Inheritance Hierarchy

System.Object
  Amazon.MediaConvert.Model.Job

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

Syntax

C#
public class Job

The Job type exposes the following members

Constructors

NameDescription
Public Method Job()

Properties

NameTypeDescription
Public Property AccelerationSettings Amazon.MediaConvert.Model.AccelerationSettings

Gets and sets the property AccelerationSettings. Accelerated transcoding can significantly speed up jobs with long, visually complex content.

Public Property AccelerationStatus Amazon.MediaConvert.AccelerationStatus

Gets and sets the property AccelerationStatus. Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.

Public Property Arn System.String

Gets and sets the property Arn. An identifier for this resource that is unique within all of AWS.

Public Property BillingTagsSource Amazon.MediaConvert.BillingTagsSource

Gets and sets the property BillingTagsSource. The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.

Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken. Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt. The time, in Unix epoch format in seconds, when the job got created.

Public Property CurrentPhase Amazon.MediaConvert.JobPhase

Gets and sets the property CurrentPhase. A job's phase can be PROBING, TRANSCODING OR UPLOADING

Public Property ErrorCode System.Int32

Gets and sets the property ErrorCode. Error code for the job

Public Property ErrorMessage System.String

Gets and sets the property ErrorMessage. Error message of Job

Public Property HopDestinations System.Collections.Generic.List<Amazon.MediaConvert.Model.HopDestination>

Gets and sets the property HopDestinations. Optional list of hop destinations.

Public Property Id System.String

Gets and sets the property Id. A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

Public Property JobPercentComplete System.Int32

Gets and sets the property JobPercentComplete. An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.

Public Property JobTemplate System.String

Gets and sets the property JobTemplate. The job template that the job is created from, if it is created from a job template.

Public Property Messages Amazon.MediaConvert.Model.JobMessages

Gets and sets the property Messages. Provides messages from the service about jobs that you have already successfully submitted.

Public Property OutputGroupDetails System.Collections.Generic.List<Amazon.MediaConvert.Model.OutputGroupDetail>

Gets and sets the property OutputGroupDetails. List of output group details

Public Property Priority System.Int32

Gets and sets the property Priority. Relative priority on the job.

Public Property Queue System.String

Gets and sets the property Queue. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Public Property QueueTransitions System.Collections.Generic.List<Amazon.MediaConvert.Model.QueueTransition>

Gets and sets the property QueueTransitions. The job's queue hopping history.

Public Property RetryCount System.Int32

Gets and sets the property RetryCount. The number of times that the service automatically attempted to process your job after encountering an error.

Public Property Role System.String

Gets and sets the property Role. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

Public Property Settings Amazon.MediaConvert.Model.JobSettings

Gets and sets the property Settings. JobSettings contains all the transcode settings for a job.

Public Property SimulateReservedQueue Amazon.MediaConvert.SimulateReservedQueue

Gets and sets the property SimulateReservedQueue. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.

Public Property Status Amazon.MediaConvert.JobStatus

Gets and sets the property Status. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Public Property StatusUpdateInterval Amazon.MediaConvert.StatusUpdateInterval

Gets and sets the property StatusUpdateInterval. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

Public Property Timing Amazon.MediaConvert.Model.Timing

Gets and sets the property Timing. Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

Public Property UserMetadata System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property UserMetadata. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

Public Property Warnings System.Collections.Generic.List<Amazon.MediaConvert.Model.WarningGroup>

Gets and sets the property Warnings. Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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