Job
¶
Source code in docs_src/capo_mediaconvert/types/job.py
acceleration_settings
instance-attribute
¶
acceleration_settings: NotRequired[AccelerationSettings]
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
acceleration_status
instance-attribute
¶
acceleration_status: NotRequired[AccelerationStatus]
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.
arn
instance-attribute
¶
arn: NotRequired[__string]
An identifier for this resource that is unique within all of AWS.
billing_tags_source
instance-attribute
¶
billing_tags_source: NotRequired[BillingTagsSource]
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
instance-attribute
¶
client_request_token: NotRequired[__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.
created_at
instance-attribute
¶
created_at: NotRequired[__timestampUnix]
The time, in Unix epoch format in seconds, when the job got created.
current_phase
instance-attribute
¶
current_phase: NotRequired[JobPhase]
A job's phase can be PROBING, TRANSCODING OR UPLOADING
elemental_inference_configuration
instance-attribute
¶
elemental_inference_configuration: NotRequired[ElementalInferenceConfiguration]
The Elemental Inference configuration used in this job.
hop_destinations
instance-attribute
¶
hop_destinations: NotRequired[__listOfHopDestination]
Optional list of hop destinations.
id
instance-attribute
¶
id: NotRequired[__string]
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
job_engine_version_requested
instance-attribute
¶
job_engine_version_requested: NotRequired[__string]
The Job engine version that you requested for your job. Valid versions are in a YYYY-MM-DD format.
job_engine_version_used
instance-attribute
¶
job_engine_version_used: NotRequired[__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.
job_percent_complete
instance-attribute
¶
job_percent_complete: NotRequired[__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.
job_template
instance-attribute
¶
job_template: NotRequired[__string]
The job template that the job is created from, if it is created from a job template.
last_share_details
instance-attribute
¶
last_share_details: NotRequired[__string]
Contains information about the most recent share attempt for the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/creating-resource-share.html
messages
instance-attribute
¶
messages: NotRequired[JobMessages]
Provides messages from the service about jobs that you have already successfully submitted.
output_group_details
instance-attribute
¶
output_group_details: NotRequired[__listOfOutputGroupDetail]
List of output group details
priority
instance-attribute
¶
priority: NotRequired[__integerMinNegative50Max50]
Relative priority on the job.
queue
instance-attribute
¶
queue: NotRequired[__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 https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
queue_transitions
instance-attribute
¶
queue_transitions: NotRequired[__listOfQueueTransition]
The job's queue hopping history.
retry_count
instance-attribute
¶
retry_count: NotRequired[__integer]
The number of times that the service automatically attempted to process your job after encountering an error.
role
instance-attribute
¶
role: NotRequired[__string]
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
settings
instance-attribute
¶
settings: NotRequired[JobSettings]
JobSettings contains all the transcode settings for a job.
share_status
instance-attribute
¶
share_status: NotRequired[ShareStatus]
A job's share status can be NOT_SHARED, INITIATED, or SHARED
simulate_reserved_queue
instance-attribute
¶
simulate_reserved_queue: NotRequired[SimulateReservedQueue]
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.
status
instance-attribute
¶
status: NotRequired[JobStatus]
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
status_update_interval
instance-attribute
¶
status_update_interval: NotRequired[StatusUpdateInterval]
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.
timing
instance-attribute
¶
timing: NotRequired[Timing]
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
user_metadata
instance-attribute
¶
user_metadata: NotRequired[__mapOf__string]
User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
warnings
instance-attribute
¶
warnings: NotRequired[__listOfWarningGroup]
Contains any warning messages for the job. Use to help identify potential issues with your input, output, or job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html