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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#acceleration_settingsTypes::AccelerationSettings

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



8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#arnString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#billing_tags_sourceString

Optional. Choose a 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. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#current_phaseString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#error_codeInteger

Error code for the job

Returns:

  • (Integer)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#error_messageString

Error message of Job

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#job_percent_completeInteger

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)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#job_templateString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#output_group_detailsArray<Types::OutputGroupDetail>

List of output group details

Returns:



8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#priorityInteger

Relative priority on the job.

Returns:

  • (Integer)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#queueString

Optional. 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 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#retry_countInteger

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

Returns:

  • (Integer)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#roleString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#settingsTypes::JobSettings

JobSettings contains all the transcode settings for a job.

Returns:



8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#simulate_reserved_queueString

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.

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#status_update_intervalString

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.

Returns:

  • (String)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#timingTypes::Timing

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

Returns:



8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#user_metadataHash<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>)


8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8679

class Job < Struct.new(
  :acceleration_settings,
  :arn,
  :billing_tags_source,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :id,
  :job_percent_complete,
  :job_template,
  :output_group_details,
  :priority,
  :queue,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata)
  include Aws::Structure
end