You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaConvert::Types::Job

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#acceleration_settings ⇒ Types::AccelerationSettings

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

Returns:

#acceleration_status ⇒ String

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.

Possible values:

  • NOT_APPLICABLE
  • IN_PROGRESS
  • ACCELERATED
  • NOT_ACCELERATED

Returns:

  • (String) —

    Describes whether the current job is running with accelerated transcoding.

#arn ⇒ String

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

Returns:

  • (String) —

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

#billing_tags_source ⇒ String

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.

Possible values:

  • QUEUE
  • PRESET
  • JOB_TEMPLATE
  • JOB

Returns:

  • (String) —

    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.

#created_at ⇒ Time

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

Returns:

  • (Time) —

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

#current_phase ⇒ String

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

Possible values:

  • PROBING
  • TRANSCODING
  • UPLOADING

Returns:

  • (String) —

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

#error_code ⇒ Integer

Error code for the job

Returns:

  • (Integer) —

    Error code for the job.

#error_message ⇒ String

Error message of Job

Returns:

  • (String) —

    Error message of Job.

#hop_destinations ⇒ Array<Types::HopDestination>

Optional list of hop destinations.

Returns:

#id ⇒ String

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

Returns:

  • (String) —

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

#job_percent_complete ⇒ Integer

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.

Returns:

  • (Integer) —

    An estimate of how far your job has progressed.

#job_template ⇒ String

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

Returns:

  • (String) —

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

#messages ⇒ Types::JobMessages

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

Returns:

  • (Types::JobMessages) —

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

#output_group_details ⇒ Array<Types::OutputGroupDetail>

List of output group details

Returns:

#priority ⇒ Integer

Relative priority on the job.

Returns:

  • (Integer) —

    Relative priority on the job.

#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

Returns:

  • (String) —

    When you create a job, you can specify a queue to send it to.

#queue_transitions ⇒ Array<Types::QueueTransition>

The job\'s queue hopping history.

Returns:

#retry_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#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

Returns:

  • (String) —

    The IAM role you use for creating this job.

#settings ⇒ Types::JobSettings

JobSettings contains all the transcode settings for a job.

Returns:

#simulate_reserved_queue ⇒ String

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.

Possible values:

  • DISABLED
  • ENABLED

Returns:

  • (String) —

    Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.

#status ⇒ String

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

Possible values:

  • SUBMITTED
  • PROGRESSING
  • COMPLETE
  • CANCELED
  • ERROR

Returns:

  • (String) —

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

#status_update_interval ⇒ String

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.

Possible values:

  • SECONDS_10
  • SECONDS_12
  • SECONDS_15
  • SECONDS_20
  • SECONDS_30
  • SECONDS_60
  • SECONDS_120
  • SECONDS_180
  • SECONDS_240
  • SECONDS_300
  • SECONDS_360
  • SECONDS_420
  • SECONDS_480
  • SECONDS_540
  • SECONDS_600

Returns:

  • (String) —

    Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.

#timing ⇒ Types::Timing

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

Returns:

  • (Types::Timing) —

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

#user_metadata ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

    User-defined metadata that you want to associate with an MediaConvert job.