Amazonka.MediaConvert.Types.Job

Documentation

data Job

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

See: newJob smart constructor.

Constructors

Job'

Fields

• accelerationSettings :: Maybe AccelerationSettings

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

• accelerationStatus :: Maybe 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 :: Maybe Text

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

• billingTagsSource :: Maybe 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.

• createdAt :: Maybe POSIX

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

• currentPhase :: Maybe JobPhase

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

• errorCode :: Maybe Int

  Error code for the job

• errorMessage :: Maybe Text

  Error message of Job

• hopDestinations :: Maybe [HopDestination]

  Optional list of hop destinations.

• id :: Maybe Text

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

• jobPercentComplete :: Maybe 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 :: Maybe Text

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

• messages :: Maybe JobMessages

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

• outputGroupDetails :: Maybe [OutputGroupDetail]

  List of output group details

• priority :: Maybe Int

  Relative priority on the job.

• queue :: Maybe Text

  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 :: Maybe [QueueTransition]

  The job's queue hopping history.

• retryCount :: Maybe Int

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

• simulateReservedQueue :: Maybe 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 :: Maybe JobStatus

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

• statusUpdateInterval :: Maybe 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 :: Maybe Timing

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

• userMetadata :: Maybe (HashMap Text Text)

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

• role' :: Text

  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 :: JobSettings

  JobSettings contains all the transcode settings for a job.

Instances

FromJSON Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

parseJSON :: Value -> Parser Job

parseJSONList :: Value -> Parser [Job]

Generic Job

Defined in Amazonka.MediaConvert.Types.Job

Associated Types

type Rep Job :: Type -> Type

Methods

from :: Job -> Rep Job x

to :: Rep Job x -> Job

Read Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

readsPrec :: Int -> ReadS Job

readList :: ReadS [Job]

readPrec :: ReadPrec Job

readListPrec :: ReadPrec [Job]

Show Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

showsPrec :: Int -> Job -> ShowS

show :: Job -> String

showList :: [Job] -> ShowS

NFData Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

rnf :: Job -> ()

Eq Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

(==) :: Job -> Job -> Bool

(/=) :: Job -> Job -> Bool

Hashable Job

Defined in Amazonka.MediaConvert.Types.Job

Methods

hashWithSalt :: Int -> Job -> Int

hash :: Job -> Int

type Rep Job

Defined in Amazonka.MediaConvert.Types.Job

type Rep Job = D1 ('MetaData "Job" "Amazonka.MediaConvert.Types.Job" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accelerationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccelerationSettings)) :*: (S1 ('MetaSel ('Just "accelerationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccelerationStatus)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "billingTagsSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingTagsSource)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "currentPhase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobPhase))))) :*: ((S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hopDestinations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HopDestination])))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobPercentComplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "jobTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobMessages)) :*: (S1 ('MetaSel ('Just "outputGroupDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputGroupDetail])) :*: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "queue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "queueTransitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueueTransition])) :*: S1 ('MetaSel ('Just "retryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "simulateReservedQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SimulateReservedQueue)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "statusUpdateInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusUpdateInterval)))) :*: ((S1 ('MetaSel ('Just "timing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Timing)) :*: S1 ('MetaSel ('Just "userMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobSettings)))))))

newJob

Arguments

:: Text

$sel:role':Job'

-> JobSettings

$sel:settings:Job'

-> Job

Create a value of Job with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accelerationSettings:Job', job_accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content.

$sel:accelerationStatus:Job', job_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.

$sel:arn:Job', job_arn - An identifier for this resource that is unique within all of AWS.

$sel:billingTagsSource:Job', job_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.

$sel:createdAt:Job', job_createdAt - The time, in Unix epoch format in seconds, when the job got created.

$sel:currentPhase:Job', job_currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING

$sel:errorCode:Job', job_errorCode - Error code for the job

$sel:errorMessage:Job', job_errorMessage - Error message of Job

$sel:hopDestinations:Job', job_hopDestinations - Optional list of hop destinations.

$sel:id:Job', job_id - A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources

$sel:jobPercentComplete:Job', job_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.

$sel:jobTemplate:Job', job_jobTemplate - The job template that the job is created from, if it is created from a job template.

$sel:messages:Job', job_messages - Provides messages from the service about jobs that you have already successfully submitted.

$sel:outputGroupDetails:Job', job_outputGroupDetails - List of output group details

Job, job_priority - Relative priority on the job.

Job, job_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

$sel:queueTransitions:Job', job_queueTransitions - The job's queue hopping history.

$sel:retryCount:Job', job_retryCount - The number of times that the service automatically attempted to process your job after encountering an error.

$sel:simulateReservedQueue:Job', job_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.

$sel:status:Job', job_status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

$sel:statusUpdateInterval:Job', job_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.

$sel:timing:Job', job_timing - Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.

$sel:userMetadata:Job', job_userMetadata - User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

$sel:role':Job', job_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

$sel:settings:Job', job_settings - JobSettings contains all the transcode settings for a job.

job_accelerationSettings :: Lens' Job (Maybe AccelerationSettings)

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

job_accelerationStatus :: Lens' Job (Maybe 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.

job_arn :: Lens' Job (Maybe Text)

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

job_billingTagsSource :: Lens' Job (Maybe 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.

job_createdAt :: Lens' Job (Maybe UTCTime)

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

job_currentPhase :: Lens' Job (Maybe JobPhase)

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

job_errorCode :: Lens' Job (Maybe Int)

Error code for the job

job_errorMessage :: Lens' Job (Maybe Text)

Error message of Job

job_hopDestinations :: Lens' Job (Maybe [HopDestination])

Optional list of hop destinations.

job_id :: Lens' Job (Maybe Text)

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

job_jobPercentComplete :: Lens' Job (Maybe 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.

job_jobTemplate :: Lens' Job (Maybe Text)

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

job_messages :: Lens' Job (Maybe JobMessages)

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

job_outputGroupDetails :: Lens' Job (Maybe [OutputGroupDetail])

List of output group details

job_priority :: Lens' Job (Maybe Int)

Relative priority on the job.

job_queue :: Lens' Job (Maybe Text)

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

job_queueTransitions :: Lens' Job (Maybe [QueueTransition])

The job's queue hopping history.

job_retryCount :: Lens' Job (Maybe Int)

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

job_simulateReservedQueue :: Lens' Job (Maybe 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.

job_status :: Lens' Job (Maybe JobStatus)

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

job_statusUpdateInterval :: Lens' Job (Maybe 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.

job_timing :: Lens' Job (Maybe Timing)

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

job_userMetadata :: Lens' Job (Maybe (HashMap Text Text))

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

job_role :: Lens' Job Text

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

job_settings :: Lens' Job JobSettings

JobSettings contains all the transcode settings for a job.