mediaconvert/aws.sdk.kotlin.services.mediaconvert.model/Job/Builder

Builder

Properties

var accelerationSettings: AccelerationSettings?

Accelerated transcoding can significantly speed up jobs with long, visually complex content.

var accelerationStatus: 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.

arn

var arn: String?

An identifier for this resource that is unique within all of AWS.

billingTagsSource

var billingTagsSource: 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.

clientRequestToken

var clientRequestToken: String?

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.

createdAt

var createdAt: Instant?

The time, in Unix epoch format in seconds, when the job got created.

currentPhase

var currentPhase: JobPhase?

A job's phase can be PROBING, TRANSCODING OR UPLOADING

errorCode

var errorCode: Int?

Error code for the job

errorMessage

var errorMessage: String?

Error message of Job

hopDestinations

var hopDestinations: List<HopDestination>?

Optional list of hop destinations.

var id: String?

A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

jobEngineVersionRequested

var jobEngineVersionRequested: String?

The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.

jobEngineVersionUsed

var jobEngineVersionUsed: String?

The Job engine version that your job used. Job engine versions are in a YYYY-MM-DD format. When you request an expired version, the response for this property will be empty. Requests to create jobs with an expired version result in a regular job, as if no specific Job engine version was requested. When you request an invalid version, the response for this property will be empty. Requests to create jobs with an invalid version result in a 400 error message, and no job is created.

jobPercentComplete

var jobPercentComplete: Int?

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.

jobTemplate

var jobTemplate: String?

The job template that the job is created from, if it is created from a job template.

messages

var messages: JobMessages?

Provides messages from the service about jobs that you have already successfully submitted.

outputGroupDetails

var outputGroupDetails: List<OutputGroupDetail>?

List of output group details

priority

var priority: Int?

Relative priority on the job.

queue

var queue: String?

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

queueTransitions

var queueTransitions: List<QueueTransition>?

The job's queue hopping history.

retryCount

var retryCount: Int?

The number of times that the service automatically attempted to process your job after encountering an error.

role

var role: String?

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

settings

var settings: JobSettings?

JobSettings contains all the transcode settings for a job.

simulateReservedQueue

var simulateReservedQueue: 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.

status

var status: JobStatus?

A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

statusUpdateInterval

var statusUpdateInterval: 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.

timing

var timing: Timing?

Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

userMetadata

var userMetadata: Map<String, String>?

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

warnings

var warnings: List<WarningGroup>?

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

Functions

accelerationSettings

fun accelerationSettings(block: AccelerationSettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediaconvert.model.AccelerationSettings inside the given block

messages

fun messages(block: JobMessages.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediaconvert.model.JobMessages inside the given block

settings

fun settings(block: JobSettings.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediaconvert.model.JobSettings inside the given block

timing

fun timing(block: Timing.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediaconvert.model.Timing inside the given block