Struct aws_sdk_mediaconvert::types::Job

#[non_exhaustive]
pub struct Job {

    pub acceleration_settings: Option<AccelerationSettings>,
    pub acceleration_status: Option<AccelerationStatus>,
    pub arn: Option<String>,
    pub billing_tags_source: Option<BillingTagsSource>,
    pub client_request_token: Option<String>,
    pub created_at: Option<DateTime>,
    pub current_phase: Option<JobPhase>,
    pub error_code: Option<i32>,
    pub error_message: Option<String>,
    pub hop_destinations: Option<Vec<HopDestination>>,
    pub id: Option<String>,
    pub job_percent_complete: Option<i32>,
    pub job_template: Option<String>,
    pub messages: Option<JobMessages>,
    pub output_group_details: Option<Vec<OutputGroupDetail>>,
    pub priority: Option<i32>,
    pub queue: Option<String>,
    pub queue_transitions: Option<Vec<QueueTransition>>,
    pub retry_count: Option<i32>,
    pub role: Option<String>,
    pub settings: Option<JobSettings>,
    pub simulate_reserved_queue: Option<SimulateReservedQueue>,
    pub status: Option<JobStatus>,
    pub status_update_interval: Option<StatusUpdateInterval>,
    pub timing: Option<Timing>,
    pub user_metadata: Option<HashMap<String, String>>,
    pub warnings: Option<Vec<WarningGroup>>,
}

Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

acceleration_settings: Option<AccelerationSettings>

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

acceleration_status: Option<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: Option<String>

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

billing_tags_source: Option<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: Option<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: Option<DateTime>

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

current_phase: Option<JobPhase>

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

error_code: Option<i32>

Error code for the job

error_message: Option<String>

Error message of Job

hop_destinations: Option<Vec<HopDestination>>

Optional list of hop destinations.

id: Option<String>

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

job_percent_complete: Option<i32>

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: Option<String>

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

messages: Option<JobMessages>

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

output_group_details: Option<Vec<OutputGroupDetail>>

List of output group details

priority: Option<i32>

Relative priority on the job.

queue: Option<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: Option<Vec<QueueTransition>>

The job’s queue hopping history.

retry_count: Option<i32>

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

role: Option<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: Option<JobSettings>

JobSettings contains all the transcode settings for a job.

simulate_reserved_queue: Option<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: Option<JobStatus>

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

status_update_interval: Option<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: Option<Timing>

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

user_metadata: Option<HashMap<String, String>>

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

warnings: Option<Vec<WarningGroup>>

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

Implementations

impl Job

pub fn acceleration_settings(&self) -> Option<&AccelerationSettings>

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

pub fn acceleration_status(&self) -> Option<&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.

pub fn arn(&self) -> Option<&str>

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

pub fn billing_tags_source(&self) -> Option<&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.

pub fn client_request_token(&self) -> Option<&str>

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.

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn current_phase(&self) -> Option<&JobPhase>

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

pub fn error_code(&self) -> Option<i32>

Error code for the job

pub fn error_message(&self) -> Option<&str>

Error message of Job

pub fn hop_destinations(&self) -> &[HopDestination]

Optional list of hop destinations.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .hop_destinations.is_none().

pub fn id(&self) -> Option<&str>

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

pub fn job_percent_complete(&self) -> Option<i32>

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.

pub fn job_template(&self) -> Option<&str>

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

pub fn messages(&self) -> Option<&JobMessages>

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

pub fn output_group_details(&self) -> &[OutputGroupDetail]

List of output group details

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_group_details.is_none().

pub fn priority(&self) -> Option<i32>

Relative priority on the job.

pub fn queue(&self) -> Option<&str>

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

pub fn queue_transitions(&self) -> &[QueueTransition]

The job’s queue hopping history.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .queue_transitions.is_none().

pub fn retry_count(&self) -> Option<i32>

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

pub fn role(&self) -> Option<&str>

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

pub fn settings(&self) -> Option<&JobSettings>

JobSettings contains all the transcode settings for a job.

pub fn simulate_reserved_queue(&self) -> Option<&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.

pub fn status(&self) -> Option<&JobStatus>

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

pub fn status_update_interval(&self) -> Option<&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.

pub fn timing(&self) -> Option<&Timing>

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

pub fn user_metadata(&self) -> Option<&HashMap<String, String>>

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

pub fn warnings(&self) -> &[WarningGroup]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none().

impl Job

pub fn builder() -> JobBuilder

Creates a new builder-style object to manufacture Job.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Job

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Job

fn eq(&self, other: &Job) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Job