Class: Aws::MediaConvert::Types::CreateJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MediaConvert::Types::CreateJobRequest
- Defined in:
- gems/aws-sdk-mediaconvert/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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#acceleration_settings ⇒ Types::AccelerationSettings
Optional.
-
#billing_tags_source ⇒ String
Optional.
-
#client_request_token ⇒ String
Prevent duplicate jobs from being created and ensure idempotency for your requests.
-
#hop_destinations ⇒ Array<Types::HopDestination>
Optional.
-
#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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :job_template, :priority, :queue, :role, :settings, :simulate_reserved_queue, :status_update_interval, :tags, :user_metadata) SENSITIVE = [] include Aws::Structure end |
#billing_tags_source ⇒ String
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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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 https://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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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 https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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 https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :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.
2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 |
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 2997 class CreateJobRequest < Struct.new( :acceleration_settings, :billing_tags_source, :client_request_token, :hop_destinations, :job_template, :priority, :queue, :role, :settings, :simulate_reserved_queue, :status_update_interval, :tags, :user_metadata) SENSITIVE = [] include Aws::Structure end |