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

#arnString

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

Returns:

  • (String)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#error_codeInteger

Error code for the job

Returns:

  • (Integer)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#error_messageString

Error message of Job

Returns:

  • (String)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :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)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#output_group_detailsArray<Types::OutputGroupDetail>

List of output group details

Returns:



6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :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)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :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)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#settingsTypes::JobSettings

JobSettings contains all the transcode settings for a job.

Returns:



6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :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:



6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :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>)


6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 6396

class Job < Struct.new(
  :arn,
  :created_at,
  :error_code,
  :error_message,
  :id,
  :job_template,
  :output_group_details,
  :queue,
  :role,
  :settings,
  :status,
  :timing,
  :user_metadata)
  include Aws::Structure
end