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

Inherits:

Struct

Object
Struct
Aws::MediaConvert::Types::Job

show all

Includes:: Structure

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#acceleration_settings ⇒ Types::AccelerationSettings

Accelerated transcoding can significantly speed up jobs with long, visually complex content.
#acceleration_status ⇒ 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.
#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.
#client_request_token ⇒ String

Prevent duplicate jobs from being created and ensure idempotency for your requests.
#created_at ⇒ 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.
#error_code ⇒ Integer

Error code for the job.
#error_message ⇒ String

Error message of Job.
#hop_destinations ⇒ Array<Types::HopDestination>

Optional list of hop destinations.
#id ⇒ String

A portion of the job’s ARN, unique within your AWS Elemental MediaConvert resources.
#job_engine_version_requested ⇒ String

The Job engine version that you requested for your job.
#job_engine_version_used ⇒ String

The Job engine version that your job used.
#job_percent_complete ⇒ 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.
#messages ⇒ 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.
#priority ⇒ Integer

Relative priority on the job.
#queue ⇒ 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.
#retry_count ⇒ 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.
#settings ⇒ Types::JobSettings

JobSettings contains all the transcode settings for a job.
#simulate_reserved_queue ⇒ 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.
#status_update_interval ⇒ 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.
#user_metadata ⇒ Hash<String,String>

User-defined metadata that you want to associate with an MediaConvert job.
#warnings ⇒ Array<Types::WarningGroup>

Contains any warning messages for the job.

Instance Attribute Details

#acceleration_settings ⇒ `Types::AccelerationSettings`

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

Returns:

(Types::AccelerationSettings)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ `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 docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#current_phase ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ `Integer`

Error code for the job

Returns:

(Integer)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ `String`

Error message of Job

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#hop_destinations ⇒ `Array<Types::HopDestination>`

Optional list of hop destinations.

Returns:

(Array<Types::HopDestination>)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#job_engine_version_requested ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#job_engine_version_used ⇒ `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.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#job_template ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#messages ⇒ `Types::JobMessages`

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

Returns:

(Types::JobMessages)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#output_group_details ⇒ `Array<Types::OutputGroupDetail>`

List of output group details

Returns:

(Array<Types::OutputGroupDetail>)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ `Integer`

Relative priority on the job.

Returns:

(Integer)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#queue_transitions ⇒ `Array<Types::QueueTransition>`

The job’s queue hopping history.

Returns:

(Array<Types::QueueTransition>)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#retry_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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 docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#settings ⇒ `Types::JobSettings`

JobSettings contains all the transcode settings for a job.

Returns:

(Types::JobSettings)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#timing ⇒ `Types::Timing`

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

Returns:

(Types::Timing)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

#warnings ⇒ `Array<Types::WarningGroup>`

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

Returns:

(Array<Types::WarningGroup>)

# File 'lib/aws-sdk-mediaconvert/types.rb', line 8101

class Job < Struct.new(
  :acceleration_settings,
  :acceleration_status,
  :arn,
  :billing_tags_source,
  :client_request_token,
  :created_at,
  :current_phase,
  :error_code,
  :error_message,
  :hop_destinations,
  :id,
  :job_engine_version_requested,
  :job_engine_version_used,
  :job_percent_complete,
  :job_template,
  :messages,
  :output_group_details,
  :priority,
  :queue,
  :queue_transitions,
  :retry_count,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status,
  :status_update_interval,
  :timing,
  :user_metadata,
  :warnings)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#acceleration_settings ⇒ Types::AccelerationSettings

#acceleration_status ⇒ String

#arn ⇒ String

#billing_tags_source ⇒ String

#client_request_token ⇒ String

#created_at ⇒ Time

#current_phase ⇒ String

#error_code ⇒ Integer

#error_message ⇒ String

#hop_destinations ⇒ Array<Types::HopDestination>

#id ⇒ String

#job_engine_version_requested ⇒ String

#job_engine_version_used ⇒ String

#job_percent_complete ⇒ Integer

#job_template ⇒ String

#messages ⇒ Types::JobMessages

#output_group_details ⇒ Array<Types::OutputGroupDetail>

#priority ⇒ Integer

#queue ⇒ String

#queue_transitions ⇒ Array<Types::QueueTransition>

#retry_count ⇒ Integer

#role ⇒ String

#settings ⇒ Types::JobSettings

#simulate_reserved_queue ⇒ String

#status ⇒ String

#status_update_interval ⇒ String

#timing ⇒ Types::Timing

#user_metadata ⇒ Hash<String,String>

#warnings ⇒ Array<Types::WarningGroup>

#acceleration_settings ⇒ `Types::AccelerationSettings`

#acceleration_status ⇒ `String`

#arn ⇒ `String`

#billing_tags_source ⇒ `String`

#client_request_token ⇒ `String`

#created_at ⇒ `Time`

#current_phase ⇒ `String`

#error_code ⇒ `Integer`

#error_message ⇒ `String`

#hop_destinations ⇒ `Array<Types::HopDestination>`

#id ⇒ `String`

#job_engine_version_requested ⇒ `String`

#job_engine_version_used ⇒ `String`

#job_percent_complete ⇒ `Integer`

#job_template ⇒ `String`

#messages ⇒ `Types::JobMessages`

#output_group_details ⇒ `Array<Types::OutputGroupDetail>`

#priority ⇒ `Integer`

#queue ⇒ `String`

#queue_transitions ⇒ `Array<Types::QueueTransition>`

#retry_count ⇒ `Integer`

#role ⇒ `String`

#settings ⇒ `Types::JobSettings`

#simulate_reserved_queue ⇒ `String`

#status ⇒ `String`

#status_update_interval ⇒ `String`

#timing ⇒ `Types::Timing`

#user_metadata ⇒ `Hash<String,String>`

#warnings ⇒ `Array<Types::WarningGroup>`