Class: Aws::MediaConvert::Types::CreateJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::CreateJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-mediaconvert/types.rb

Overview

Send your create job request with your job settings and IAM role. Optionally, include user metadata and the ARN for the queue.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #acceleration_settings ⇒ Types::AccelerationSettings

  Optional.

• #billing_tags_source ⇒ String

  Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output 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.

• #hop_destinations ⇒ Array<Types::HopDestination>

  Optional.

• #job_engine_version ⇒ String

  Use Job engine versions to run jobs for your production workflow on one version, while you test and validate the latest version.

• #job_template ⇒ String

  Optional.

• #priority ⇒ Integer

  Optional.

• #queue ⇒ String

  Optional.

• #role ⇒ String

  Required.

• #settings ⇒ Types::JobSettings

  JobSettings contains all the transcode settings for a job.

• #simulate_reserved_queue ⇒ String

  Optional.

• #status_update_interval ⇒ String

  Optional.

• #tags ⇒ Hash<String,String>

  Optional.

• #user_metadata ⇒ Hash<String,String>

  Optional.

Instance Attribute Details

#acceleration_settings ⇒ Types::AccelerationSettings

Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.

Returns:

• (Types::AccelerationSettings)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#billing_tags_source ⇒ String

Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output costs on any billing report that you set up. Leave blank to use the default value, Job.

Returns:

• (String)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  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.**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#hop_destinations ⇒ Array<Types::HopDestination>

Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.

Returns:

• (Array<Types::HopDestination>)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#job_engine_version ⇒ String

Use Job engine versions to run jobs for your production workflow on one version, while you test and validate the latest version. Job engine versions represent periodically grouped MediaConvert releases with new features, updates, improvements, and fixes. Job engine versions are in a YYYY-MM-DD format. Note that the Job engine version feature is not publicly available at this time. To request access, contact AWS support.

Returns:

• (String)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#job_template ⇒ String

Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.

Returns:

• (String)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don’t specify a priority, the service uses the default value 0.

Returns:

• (Integer)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#queue ⇒ String

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

Returns:

• (String)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

Required. 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 3421

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  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 3421

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#simulate_reserved_queue ⇒ String

Optional. 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 3421

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#status_update_interval ⇒ String

Optional. 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 3421

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.

Returns:

• (Hash<String,String>)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#user_metadata ⇒ Hash<String,String>

Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.

Returns:

• (Hash<String,String>)

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

class CreateJobRequest < Struct.new(
  :acceleration_settings,
  :billing_tags_source,
  :client_request_token,
  :hop_destinations,
  :job_engine_version,
  :job_template,
  :priority,
  :queue,
  :role,
  :settings,
  :simulate_reserved_queue,
  :status_update_interval,
  :tags,
  :user_metadata)
  SENSITIVE = []
  include Aws::Structure
end