AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::Job Class Reference

#include <Job.h>

Public Member Functions

 Job ()
 
 Job (Aws::Utils::Json::JsonView jsonValue)
 
Joboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AccelerationSettingsGetAccelerationSettings () const
 
bool AccelerationSettingsHasBeenSet () const
 
void SetAccelerationSettings (const AccelerationSettings &value)
 
void SetAccelerationSettings (AccelerationSettings &&value)
 
JobWithAccelerationSettings (const AccelerationSettings &value)
 
JobWithAccelerationSettings (AccelerationSettings &&value)
 
const AccelerationStatusGetAccelerationStatus () const
 
bool AccelerationStatusHasBeenSet () const
 
void SetAccelerationStatus (const AccelerationStatus &value)
 
void SetAccelerationStatus (AccelerationStatus &&value)
 
JobWithAccelerationStatus (const AccelerationStatus &value)
 
JobWithAccelerationStatus (AccelerationStatus &&value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
JobWithArn (const Aws::String &value)
 
JobWithArn (Aws::String &&value)
 
JobWithArn (const char *value)
 
const BillingTagsSourceGetBillingTagsSource () const
 
bool BillingTagsSourceHasBeenSet () const
 
void SetBillingTagsSource (const BillingTagsSource &value)
 
void SetBillingTagsSource (BillingTagsSource &&value)
 
JobWithBillingTagsSource (const BillingTagsSource &value)
 
JobWithBillingTagsSource (BillingTagsSource &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
JobWithCreatedAt (const Aws::Utils::DateTime &value)
 
JobWithCreatedAt (Aws::Utils::DateTime &&value)
 
const JobPhaseGetCurrentPhase () const
 
bool CurrentPhaseHasBeenSet () const
 
void SetCurrentPhase (const JobPhase &value)
 
void SetCurrentPhase (JobPhase &&value)
 
JobWithCurrentPhase (const JobPhase &value)
 
JobWithCurrentPhase (JobPhase &&value)
 
int GetErrorCode () const
 
bool ErrorCodeHasBeenSet () const
 
void SetErrorCode (int value)
 
JobWithErrorCode (int value)
 
const Aws::StringGetErrorMessage () const
 
bool ErrorMessageHasBeenSet () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
JobWithErrorMessage (const Aws::String &value)
 
JobWithErrorMessage (Aws::String &&value)
 
JobWithErrorMessage (const char *value)
 
const Aws::Vector< HopDestination > & GetHopDestinations () const
 
bool HopDestinationsHasBeenSet () const
 
void SetHopDestinations (const Aws::Vector< HopDestination > &value)
 
void SetHopDestinations (Aws::Vector< HopDestination > &&value)
 
JobWithHopDestinations (const Aws::Vector< HopDestination > &value)
 
JobWithHopDestinations (Aws::Vector< HopDestination > &&value)
 
JobAddHopDestinations (const HopDestination &value)
 
JobAddHopDestinations (HopDestination &&value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
JobWithId (const Aws::String &value)
 
JobWithId (Aws::String &&value)
 
JobWithId (const char *value)
 
int GetJobPercentComplete () const
 
bool JobPercentCompleteHasBeenSet () const
 
void SetJobPercentComplete (int value)
 
JobWithJobPercentComplete (int value)
 
const Aws::StringGetJobTemplate () const
 
bool JobTemplateHasBeenSet () const
 
void SetJobTemplate (const Aws::String &value)
 
void SetJobTemplate (Aws::String &&value)
 
void SetJobTemplate (const char *value)
 
JobWithJobTemplate (const Aws::String &value)
 
JobWithJobTemplate (Aws::String &&value)
 
JobWithJobTemplate (const char *value)
 
const JobMessagesGetMessages () const
 
bool MessagesHasBeenSet () const
 
void SetMessages (const JobMessages &value)
 
void SetMessages (JobMessages &&value)
 
JobWithMessages (const JobMessages &value)
 
JobWithMessages (JobMessages &&value)
 
const Aws::Vector< OutputGroupDetail > & GetOutputGroupDetails () const
 
bool OutputGroupDetailsHasBeenSet () const
 
void SetOutputGroupDetails (const Aws::Vector< OutputGroupDetail > &value)
 
void SetOutputGroupDetails (Aws::Vector< OutputGroupDetail > &&value)
 
JobWithOutputGroupDetails (const Aws::Vector< OutputGroupDetail > &value)
 
JobWithOutputGroupDetails (Aws::Vector< OutputGroupDetail > &&value)
 
JobAddOutputGroupDetails (const OutputGroupDetail &value)
 
JobAddOutputGroupDetails (OutputGroupDetail &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
JobWithPriority (int value)
 
const Aws::StringGetQueue () const
 
bool QueueHasBeenSet () const
 
void SetQueue (const Aws::String &value)
 
void SetQueue (Aws::String &&value)
 
void SetQueue (const char *value)
 
JobWithQueue (const Aws::String &value)
 
JobWithQueue (Aws::String &&value)
 
JobWithQueue (const char *value)
 
const Aws::Vector< QueueTransition > & GetQueueTransitions () const
 
bool QueueTransitionsHasBeenSet () const
 
void SetQueueTransitions (const Aws::Vector< QueueTransition > &value)
 
void SetQueueTransitions (Aws::Vector< QueueTransition > &&value)
 
JobWithQueueTransitions (const Aws::Vector< QueueTransition > &value)
 
JobWithQueueTransitions (Aws::Vector< QueueTransition > &&value)
 
JobAddQueueTransitions (const QueueTransition &value)
 
JobAddQueueTransitions (QueueTransition &&value)
 
int GetRetryCount () const
 
bool RetryCountHasBeenSet () const
 
void SetRetryCount (int value)
 
JobWithRetryCount (int value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
JobWithRole (const Aws::String &value)
 
JobWithRole (Aws::String &&value)
 
JobWithRole (const char *value)
 
const JobSettingsGetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const JobSettings &value)
 
void SetSettings (JobSettings &&value)
 
JobWithSettings (const JobSettings &value)
 
JobWithSettings (JobSettings &&value)
 
const SimulateReservedQueueGetSimulateReservedQueue () const
 
bool SimulateReservedQueueHasBeenSet () const
 
void SetSimulateReservedQueue (const SimulateReservedQueue &value)
 
void SetSimulateReservedQueue (SimulateReservedQueue &&value)
 
JobWithSimulateReservedQueue (const SimulateReservedQueue &value)
 
JobWithSimulateReservedQueue (SimulateReservedQueue &&value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
JobWithStatus (const JobStatus &value)
 
JobWithStatus (JobStatus &&value)
 
const StatusUpdateIntervalGetStatusUpdateInterval () const
 
bool StatusUpdateIntervalHasBeenSet () const
 
void SetStatusUpdateInterval (const StatusUpdateInterval &value)
 
void SetStatusUpdateInterval (StatusUpdateInterval &&value)
 
JobWithStatusUpdateInterval (const StatusUpdateInterval &value)
 
JobWithStatusUpdateInterval (StatusUpdateInterval &&value)
 
const TimingGetTiming () const
 
bool TimingHasBeenSet () const
 
void SetTiming (const Timing &value)
 
void SetTiming (Timing &&value)
 
JobWithTiming (const Timing &value)
 
JobWithTiming (Timing &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetUserMetadata () const
 
bool UserMetadataHasBeenSet () const
 
void SetUserMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetUserMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
JobWithUserMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
JobWithUserMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
JobAddUserMetadata (const Aws::String &key, const Aws::String &value)
 
JobAddUserMetadata (Aws::String &&key, const Aws::String &value)
 
JobAddUserMetadata (const Aws::String &key, Aws::String &&value)
 
JobAddUserMetadata (Aws::String &&key, Aws::String &&value)
 
JobAddUserMetadata (const char *key, Aws::String &&value)
 
JobAddUserMetadata (Aws::String &&key, const char *value)
 
JobAddUserMetadata (const char *key, const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 50 of file Job.h.

Constructor & Destructor Documentation

◆ Job() [1/2]

Aws::MediaConvert::Model::Job::Job ( )

◆ Job() [2/2]

Aws::MediaConvert::Model::Job::Job ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccelerationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::Job::AccelerationSettingsHasBeenSet ( ) const
inline

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

Definition at line 69 of file Job.h.

◆ AccelerationStatusHasBeenSet()

bool Aws::MediaConvert::Model::Job::AccelerationStatusHasBeenSet ( ) const
inline

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.

Definition at line 124 of file Job.h.

◆ AddHopDestinations() [1/2]

Job& Aws::MediaConvert::Model::Job::AddHopDestinations ( const HopDestination value)
inline

Optional list of hop destinations.

Definition at line 422 of file Job.h.

◆ AddHopDestinations() [2/2]

Job& Aws::MediaConvert::Model::Job::AddHopDestinations ( HopDestination &&  value)
inline

Optional list of hop destinations.

Definition at line 427 of file Job.h.

◆ AddOutputGroupDetails() [1/2]

Job& Aws::MediaConvert::Model::Job::AddOutputGroupDetails ( const OutputGroupDetail value)
inline

List of output group details

Definition at line 647 of file Job.h.

◆ AddOutputGroupDetails() [2/2]

Job& Aws::MediaConvert::Model::Job::AddOutputGroupDetails ( OutputGroupDetail &&  value)
inline

List of output group details

Definition at line 652 of file Job.h.

◆ AddQueueTransitions() [1/2]

Job& Aws::MediaConvert::Model::Job::AddQueueTransitions ( const QueueTransition value)
inline

The job's queue hopping history.

Definition at line 774 of file Job.h.

◆ AddQueueTransitions() [2/2]

Job& Aws::MediaConvert::Model::Job::AddQueueTransitions ( QueueTransition &&  value)
inline

The job's queue hopping history.

Definition at line 779 of file Job.h.

◆ AddUserMetadata() [1/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 1119 of file Job.h.

◆ AddUserMetadata() [2/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 1107 of file Job.h.

◆ AddUserMetadata() [3/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 1131 of file Job.h.

◆ AddUserMetadata() [4/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 1113 of file Job.h.

◆ AddUserMetadata() [5/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 1101 of file Job.h.

◆ AddUserMetadata() [6/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 1125 of file Job.h.

◆ AddUserMetadata() [7/7]

Job& Aws::MediaConvert::Model::Job::AddUserMetadata ( const char *  key,
const char *  value 
)
inline

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

Definition at line 1137 of file Job.h.

◆ ArnHasBeenSet()

bool Aws::MediaConvert::Model::Job::ArnHasBeenSet ( ) const
inline

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

Definition at line 195 of file Job.h.

◆ BillingTagsSourceHasBeenSet()

bool Aws::MediaConvert::Model::Job::BillingTagsSourceHasBeenSet ( ) const
inline

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.

Definition at line 238 of file Job.h.

◆ CreatedAtHasBeenSet()

bool Aws::MediaConvert::Model::Job::CreatedAtHasBeenSet ( ) const
inline

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

Definition at line 273 of file Job.h.

◆ CurrentPhaseHasBeenSet()

bool Aws::MediaConvert::Model::Job::CurrentPhaseHasBeenSet ( ) const
inline

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

Definition at line 304 of file Job.h.

◆ ErrorCodeHasBeenSet()

bool Aws::MediaConvert::Model::Job::ErrorCodeHasBeenSet ( ) const
inline

Error code for the job

Definition at line 335 of file Job.h.

◆ ErrorMessageHasBeenSet()

bool Aws::MediaConvert::Model::Job::ErrorMessageHasBeenSet ( ) const
inline

Error message of Job

Definition at line 356 of file Job.h.

◆ GetAccelerationSettings()

const AccelerationSettings& Aws::MediaConvert::Model::Job::GetAccelerationSettings ( ) const
inline

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

Definition at line 63 of file Job.h.

◆ GetAccelerationStatus()

const AccelerationStatus& Aws::MediaConvert::Model::Job::GetAccelerationStatus ( ) const
inline

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.

Definition at line 109 of file Job.h.

◆ GetArn()

const Aws::String& Aws::MediaConvert::Model::Job::GetArn ( ) const
inline

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

Definition at line 190 of file Job.h.

◆ GetBillingTagsSource()

const BillingTagsSource& Aws::MediaConvert::Model::Job::GetBillingTagsSource ( ) const
inline

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.

Definition at line 232 of file Job.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::MediaConvert::Model::Job::GetCreatedAt ( ) const
inline

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

Definition at line 268 of file Job.h.

◆ GetCurrentPhase()

const JobPhase& Aws::MediaConvert::Model::Job::GetCurrentPhase ( ) const
inline

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

Definition at line 299 of file Job.h.

◆ GetErrorCode()

int Aws::MediaConvert::Model::Job::GetErrorCode ( ) const
inline

Error code for the job

Definition at line 330 of file Job.h.

◆ GetErrorMessage()

const Aws::String& Aws::MediaConvert::Model::Job::GetErrorMessage ( ) const
inline

Error message of Job

Definition at line 351 of file Job.h.

◆ GetHopDestinations()

const Aws::Vector<HopDestination>& Aws::MediaConvert::Model::Job::GetHopDestinations ( ) const
inline

Optional list of hop destinations.

Definition at line 392 of file Job.h.

◆ GetId()

const Aws::String& Aws::MediaConvert::Model::Job::GetId ( ) const
inline

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

Definition at line 434 of file Job.h.

◆ GetJobPercentComplete()

int Aws::MediaConvert::Model::Job::GetJobPercentComplete ( ) const
inline

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.

Definition at line 489 of file Job.h.

◆ GetJobTemplate()

const Aws::String& Aws::MediaConvert::Model::Job::GetJobTemplate ( ) const
inline

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

Definition at line 532 of file Job.h.

◆ GetMessages()

const JobMessages& Aws::MediaConvert::Model::Job::GetMessages ( ) const
inline

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

Definition at line 581 of file Job.h.

◆ GetOutputGroupDetails()

const Aws::Vector<OutputGroupDetail>& Aws::MediaConvert::Model::Job::GetOutputGroupDetails ( ) const
inline

List of output group details

Definition at line 617 of file Job.h.

◆ GetPriority()

int Aws::MediaConvert::Model::Job::GetPriority ( ) const
inline

Relative priority on the job.

Definition at line 658 of file Job.h.

◆ GetQueue()

const Aws::String& Aws::MediaConvert::Model::Job::GetQueue ( ) const
inline

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

Definition at line 682 of file Job.h.

◆ GetQueueTransitions()

const Aws::Vector<QueueTransition>& Aws::MediaConvert::Model::Job::GetQueueTransitions ( ) const
inline

The job's queue hopping history.

Definition at line 744 of file Job.h.

◆ GetRetryCount()

int Aws::MediaConvert::Model::Job::GetRetryCount ( ) const
inline

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

Definition at line 786 of file Job.h.

◆ GetRole()

const Aws::String& Aws::MediaConvert::Model::Job::GetRole ( ) const
inline

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

Definition at line 812 of file Job.h.

◆ GetSettings()

const JobSettings& Aws::MediaConvert::Model::Job::GetSettings ( ) const
inline

JobSettings contains all the transcode settings for a job.

Definition at line 867 of file Job.h.

◆ GetSimulateReservedQueue()

const SimulateReservedQueue& Aws::MediaConvert::Model::Job::GetSimulateReservedQueue ( ) const
inline

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.

Definition at line 901 of file Job.h.

◆ GetStatus()

const JobStatus& Aws::MediaConvert::Model::Job::GetStatus ( ) const
inline

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

Definition at line 947 of file Job.h.

◆ GetStatusUpdateInterval()

const StatusUpdateInterval& Aws::MediaConvert::Model::Job::GetStatusUpdateInterval ( ) const
inline

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.

Definition at line 981 of file Job.h.

◆ GetTiming()

const Timing& Aws::MediaConvert::Model::Job::GetTiming ( ) const
inline

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

Definition at line 1028 of file Job.h.

◆ GetUserMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::MediaConvert::Model::Job::GetUserMetadata ( ) const
inline

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

Definition at line 1065 of file Job.h.

◆ HopDestinationsHasBeenSet()

bool Aws::MediaConvert::Model::Job::HopDestinationsHasBeenSet ( ) const
inline

Optional list of hop destinations.

Definition at line 397 of file Job.h.

◆ IdHasBeenSet()

bool Aws::MediaConvert::Model::Job::IdHasBeenSet ( ) const
inline

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

Definition at line 440 of file Job.h.

◆ JobPercentCompleteHasBeenSet()

bool Aws::MediaConvert::Model::Job::JobPercentCompleteHasBeenSet ( ) const
inline

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.

Definition at line 501 of file Job.h.

◆ JobTemplateHasBeenSet()

bool Aws::MediaConvert::Model::Job::JobTemplateHasBeenSet ( ) const
inline

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

Definition at line 538 of file Job.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::Job::Jsonize ( ) const

◆ MessagesHasBeenSet()

bool Aws::MediaConvert::Model::Job::MessagesHasBeenSet ( ) const
inline

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

Definition at line 587 of file Job.h.

◆ operator=()

Job& Aws::MediaConvert::Model::Job::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputGroupDetailsHasBeenSet()

bool Aws::MediaConvert::Model::Job::OutputGroupDetailsHasBeenSet ( ) const
inline

List of output group details

Definition at line 622 of file Job.h.

◆ PriorityHasBeenSet()

bool Aws::MediaConvert::Model::Job::PriorityHasBeenSet ( ) const
inline

Relative priority on the job.

Definition at line 663 of file Job.h.

◆ QueueHasBeenSet()

bool Aws::MediaConvert::Model::Job::QueueHasBeenSet ( ) const
inline

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

Definition at line 690 of file Job.h.

◆ QueueTransitionsHasBeenSet()

bool Aws::MediaConvert::Model::Job::QueueTransitionsHasBeenSet ( ) const
inline

The job's queue hopping history.

Definition at line 749 of file Job.h.

◆ RetryCountHasBeenSet()

bool Aws::MediaConvert::Model::Job::RetryCountHasBeenSet ( ) const
inline

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

Definition at line 792 of file Job.h.

◆ RoleHasBeenSet()

bool Aws::MediaConvert::Model::Job::RoleHasBeenSet ( ) const
inline

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

Definition at line 819 of file Job.h.

◆ SetAccelerationSettings() [1/2]

void Aws::MediaConvert::Model::Job::SetAccelerationSettings ( AccelerationSettings &&  value)
inline

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

Definition at line 81 of file Job.h.

◆ SetAccelerationSettings() [2/2]

void Aws::MediaConvert::Model::Job::SetAccelerationSettings ( const AccelerationSettings value)
inline

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

Definition at line 75 of file Job.h.

◆ SetAccelerationStatus() [1/2]

void Aws::MediaConvert::Model::Job::SetAccelerationStatus ( AccelerationStatus &&  value)
inline

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.

Definition at line 154 of file Job.h.

◆ SetAccelerationStatus() [2/2]

void Aws::MediaConvert::Model::Job::SetAccelerationStatus ( const AccelerationStatus value)
inline

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.

Definition at line 139 of file Job.h.

◆ SetArn() [1/3]

void Aws::MediaConvert::Model::Job::SetArn ( Aws::String &&  value)
inline

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

Definition at line 205 of file Job.h.

◆ SetArn() [2/3]

void Aws::MediaConvert::Model::Job::SetArn ( const Aws::String value)
inline

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

Definition at line 200 of file Job.h.

◆ SetArn() [3/3]

void Aws::MediaConvert::Model::Job::SetArn ( const char *  value)
inline

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

Definition at line 210 of file Job.h.

◆ SetBillingTagsSource() [1/2]

void Aws::MediaConvert::Model::Job::SetBillingTagsSource ( BillingTagsSource &&  value)
inline

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.

Definition at line 250 of file Job.h.

◆ SetBillingTagsSource() [2/2]

void Aws::MediaConvert::Model::Job::SetBillingTagsSource ( const BillingTagsSource value)
inline

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.

Definition at line 244 of file Job.h.

◆ SetCreatedAt() [1/2]

void Aws::MediaConvert::Model::Job::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 283 of file Job.h.

◆ SetCreatedAt() [2/2]

void Aws::MediaConvert::Model::Job::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 278 of file Job.h.

◆ SetCurrentPhase() [1/2]

void Aws::MediaConvert::Model::Job::SetCurrentPhase ( const JobPhase value)
inline

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

Definition at line 309 of file Job.h.

◆ SetCurrentPhase() [2/2]

void Aws::MediaConvert::Model::Job::SetCurrentPhase ( JobPhase &&  value)
inline

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

Definition at line 314 of file Job.h.

◆ SetErrorCode()

void Aws::MediaConvert::Model::Job::SetErrorCode ( int  value)
inline

Error code for the job

Definition at line 340 of file Job.h.

◆ SetErrorMessage() [1/3]

void Aws::MediaConvert::Model::Job::SetErrorMessage ( Aws::String &&  value)
inline

Error message of Job

Definition at line 366 of file Job.h.

◆ SetErrorMessage() [2/3]

void Aws::MediaConvert::Model::Job::SetErrorMessage ( const Aws::String value)
inline

Error message of Job

Definition at line 361 of file Job.h.

◆ SetErrorMessage() [3/3]

void Aws::MediaConvert::Model::Job::SetErrorMessage ( const char *  value)
inline

Error message of Job

Definition at line 371 of file Job.h.

◆ SetHopDestinations() [1/2]

void Aws::MediaConvert::Model::Job::SetHopDestinations ( Aws::Vector< HopDestination > &&  value)
inline

Optional list of hop destinations.

Definition at line 407 of file Job.h.

◆ SetHopDestinations() [2/2]

void Aws::MediaConvert::Model::Job::SetHopDestinations ( const Aws::Vector< HopDestination > &  value)
inline

Optional list of hop destinations.

Definition at line 402 of file Job.h.

◆ SetId() [1/3]

void Aws::MediaConvert::Model::Job::SetId ( Aws::String &&  value)
inline

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

Definition at line 452 of file Job.h.

◆ SetId() [2/3]

void Aws::MediaConvert::Model::Job::SetId ( const Aws::String value)
inline

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

Definition at line 446 of file Job.h.

◆ SetId() [3/3]

void Aws::MediaConvert::Model::Job::SetId ( const char *  value)
inline

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

Definition at line 458 of file Job.h.

◆ SetJobPercentComplete()

void Aws::MediaConvert::Model::Job::SetJobPercentComplete ( int  value)
inline

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.

Definition at line 513 of file Job.h.

◆ SetJobTemplate() [1/3]

void Aws::MediaConvert::Model::Job::SetJobTemplate ( Aws::String &&  value)
inline

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

Definition at line 550 of file Job.h.

◆ SetJobTemplate() [2/3]

void Aws::MediaConvert::Model::Job::SetJobTemplate ( const Aws::String value)
inline

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

Definition at line 544 of file Job.h.

◆ SetJobTemplate() [3/3]

void Aws::MediaConvert::Model::Job::SetJobTemplate ( const char *  value)
inline

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

Definition at line 556 of file Job.h.

◆ SetMessages() [1/2]

void Aws::MediaConvert::Model::Job::SetMessages ( const JobMessages value)
inline

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

Definition at line 593 of file Job.h.

◆ SetMessages() [2/2]

void Aws::MediaConvert::Model::Job::SetMessages ( JobMessages &&  value)
inline

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

Definition at line 599 of file Job.h.

◆ SetOutputGroupDetails() [1/2]

void Aws::MediaConvert::Model::Job::SetOutputGroupDetails ( Aws::Vector< OutputGroupDetail > &&  value)
inline

List of output group details

Definition at line 632 of file Job.h.

◆ SetOutputGroupDetails() [2/2]

void Aws::MediaConvert::Model::Job::SetOutputGroupDetails ( const Aws::Vector< OutputGroupDetail > &  value)
inline

List of output group details

Definition at line 627 of file Job.h.

◆ SetPriority()

void Aws::MediaConvert::Model::Job::SetPriority ( int  value)
inline

Relative priority on the job.

Definition at line 668 of file Job.h.

◆ SetQueue() [1/3]

void Aws::MediaConvert::Model::Job::SetQueue ( Aws::String &&  value)
inline

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

Definition at line 706 of file Job.h.

◆ SetQueue() [2/3]

void Aws::MediaConvert::Model::Job::SetQueue ( const Aws::String value)
inline

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

Definition at line 698 of file Job.h.

◆ SetQueue() [3/3]

void Aws::MediaConvert::Model::Job::SetQueue ( const char *  value)
inline

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

Definition at line 714 of file Job.h.

◆ SetQueueTransitions() [1/2]

void Aws::MediaConvert::Model::Job::SetQueueTransitions ( Aws::Vector< QueueTransition > &&  value)
inline

The job's queue hopping history.

Definition at line 759 of file Job.h.

◆ SetQueueTransitions() [2/2]

void Aws::MediaConvert::Model::Job::SetQueueTransitions ( const Aws::Vector< QueueTransition > &  value)
inline

The job's queue hopping history.

Definition at line 754 of file Job.h.

◆ SetRetryCount()

void Aws::MediaConvert::Model::Job::SetRetryCount ( int  value)
inline

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

Definition at line 798 of file Job.h.

◆ SetRole() [1/3]

void Aws::MediaConvert::Model::Job::SetRole ( Aws::String &&  value)
inline

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

Definition at line 833 of file Job.h.

◆ SetRole() [2/3]

void Aws::MediaConvert::Model::Job::SetRole ( const Aws::String value)
inline

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

Definition at line 826 of file Job.h.

◆ SetRole() [3/3]

void Aws::MediaConvert::Model::Job::SetRole ( const char *  value)
inline

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

Definition at line 840 of file Job.h.

◆ SetSettings() [1/2]

void Aws::MediaConvert::Model::Job::SetSettings ( const JobSettings value)
inline

JobSettings contains all the transcode settings for a job.

Definition at line 877 of file Job.h.

◆ SetSettings() [2/2]

void Aws::MediaConvert::Model::Job::SetSettings ( JobSettings &&  value)
inline

JobSettings contains all the transcode settings for a job.

Definition at line 882 of file Job.h.

◆ SetSimulateReservedQueue() [1/2]

void Aws::MediaConvert::Model::Job::SetSimulateReservedQueue ( const SimulateReservedQueue value)
inline

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.

Definition at line 917 of file Job.h.

◆ SetSimulateReservedQueue() [2/2]

void Aws::MediaConvert::Model::Job::SetSimulateReservedQueue ( SimulateReservedQueue &&  value)
inline

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.

Definition at line 925 of file Job.h.

◆ SetStatus() [1/2]

void Aws::MediaConvert::Model::Job::SetStatus ( const JobStatus value)
inline

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

Definition at line 957 of file Job.h.

◆ SetStatus() [2/2]

void Aws::MediaConvert::Model::Job::SetStatus ( JobStatus &&  value)
inline

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

Definition at line 962 of file Job.h.

◆ SetStatusUpdateInterval() [1/2]

void Aws::MediaConvert::Model::Job::SetStatusUpdateInterval ( const StatusUpdateInterval value)
inline

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.

Definition at line 997 of file Job.h.

◆ SetStatusUpdateInterval() [2/2]

void Aws::MediaConvert::Model::Job::SetStatusUpdateInterval ( StatusUpdateInterval &&  value)
inline

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.

Definition at line 1005 of file Job.h.

◆ SetTiming() [1/2]

void Aws::MediaConvert::Model::Job::SetTiming ( const Timing value)
inline

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

Definition at line 1040 of file Job.h.

◆ SetTiming() [2/2]

void Aws::MediaConvert::Model::Job::SetTiming ( Timing &&  value)
inline

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

Definition at line 1046 of file Job.h.

◆ SettingsHasBeenSet()

bool Aws::MediaConvert::Model::Job::SettingsHasBeenSet ( ) const
inline

JobSettings contains all the transcode settings for a job.

Definition at line 872 of file Job.h.

◆ SetUserMetadata() [1/2]

void Aws::MediaConvert::Model::Job::SetUserMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 1083 of file Job.h.

◆ SetUserMetadata() [2/2]

void Aws::MediaConvert::Model::Job::SetUserMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 1077 of file Job.h.

◆ SimulateReservedQueueHasBeenSet()

bool Aws::MediaConvert::Model::Job::SimulateReservedQueueHasBeenSet ( ) const
inline

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.

Definition at line 909 of file Job.h.

◆ StatusHasBeenSet()

bool Aws::MediaConvert::Model::Job::StatusHasBeenSet ( ) const
inline

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

Definition at line 952 of file Job.h.

◆ StatusUpdateIntervalHasBeenSet()

bool Aws::MediaConvert::Model::Job::StatusUpdateIntervalHasBeenSet ( ) const
inline

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.

Definition at line 989 of file Job.h.

◆ TimingHasBeenSet()

bool Aws::MediaConvert::Model::Job::TimingHasBeenSet ( ) const
inline

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

Definition at line 1034 of file Job.h.

◆ UserMetadataHasBeenSet()

bool Aws::MediaConvert::Model::Job::UserMetadataHasBeenSet ( ) const
inline

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

Definition at line 1071 of file Job.h.

◆ WithAccelerationSettings() [1/2]

Job& Aws::MediaConvert::Model::Job::WithAccelerationSettings ( AccelerationSettings &&  value)
inline

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

Definition at line 93 of file Job.h.

◆ WithAccelerationSettings() [2/2]

Job& Aws::MediaConvert::Model::Job::WithAccelerationSettings ( const AccelerationSettings value)
inline

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

Definition at line 87 of file Job.h.

◆ WithAccelerationStatus() [1/2]

Job& Aws::MediaConvert::Model::Job::WithAccelerationStatus ( AccelerationStatus &&  value)
inline

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.

Definition at line 184 of file Job.h.

◆ WithAccelerationStatus() [2/2]

Job& Aws::MediaConvert::Model::Job::WithAccelerationStatus ( const AccelerationStatus value)
inline

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.

Definition at line 169 of file Job.h.

◆ WithArn() [1/3]

Job& Aws::MediaConvert::Model::Job::WithArn ( Aws::String &&  value)
inline

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

Definition at line 220 of file Job.h.

◆ WithArn() [2/3]

Job& Aws::MediaConvert::Model::Job::WithArn ( const Aws::String value)
inline

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

Definition at line 215 of file Job.h.

◆ WithArn() [3/3]

Job& Aws::MediaConvert::Model::Job::WithArn ( const char *  value)
inline

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

Definition at line 225 of file Job.h.

◆ WithBillingTagsSource() [1/2]

Job& Aws::MediaConvert::Model::Job::WithBillingTagsSource ( BillingTagsSource &&  value)
inline

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.

Definition at line 262 of file Job.h.

◆ WithBillingTagsSource() [2/2]

Job& Aws::MediaConvert::Model::Job::WithBillingTagsSource ( const BillingTagsSource value)
inline

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.

Definition at line 256 of file Job.h.

◆ WithCreatedAt() [1/2]

Job& Aws::MediaConvert::Model::Job::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 293 of file Job.h.

◆ WithCreatedAt() [2/2]

Job& Aws::MediaConvert::Model::Job::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 288 of file Job.h.

◆ WithCurrentPhase() [1/2]

Job& Aws::MediaConvert::Model::Job::WithCurrentPhase ( const JobPhase value)
inline

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

Definition at line 319 of file Job.h.

◆ WithCurrentPhase() [2/2]

Job& Aws::MediaConvert::Model::Job::WithCurrentPhase ( JobPhase &&  value)
inline

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

Definition at line 324 of file Job.h.

◆ WithErrorCode()

Job& Aws::MediaConvert::Model::Job::WithErrorCode ( int  value)
inline

Error code for the job

Definition at line 345 of file Job.h.

◆ WithErrorMessage() [1/3]

Job& Aws::MediaConvert::Model::Job::WithErrorMessage ( Aws::String &&  value)
inline

Error message of Job

Definition at line 381 of file Job.h.

◆ WithErrorMessage() [2/3]

Job& Aws::MediaConvert::Model::Job::WithErrorMessage ( const Aws::String value)
inline

Error message of Job

Definition at line 376 of file Job.h.

◆ WithErrorMessage() [3/3]

Job& Aws::MediaConvert::Model::Job::WithErrorMessage ( const char *  value)
inline

Error message of Job

Definition at line 386 of file Job.h.

◆ WithHopDestinations() [1/2]

Job& Aws::MediaConvert::Model::Job::WithHopDestinations ( Aws::Vector< HopDestination > &&  value)
inline

Optional list of hop destinations.

Definition at line 417 of file Job.h.

◆ WithHopDestinations() [2/2]

Job& Aws::MediaConvert::Model::Job::WithHopDestinations ( const Aws::Vector< HopDestination > &  value)
inline

Optional list of hop destinations.

Definition at line 412 of file Job.h.

◆ WithId() [1/3]

Job& Aws::MediaConvert::Model::Job::WithId ( Aws::String &&  value)
inline

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

Definition at line 470 of file Job.h.

◆ WithId() [2/3]

Job& Aws::MediaConvert::Model::Job::WithId ( const Aws::String value)
inline

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

Definition at line 464 of file Job.h.

◆ WithId() [3/3]

Job& Aws::MediaConvert::Model::Job::WithId ( const char *  value)
inline

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

Definition at line 476 of file Job.h.

◆ WithJobPercentComplete()

Job& Aws::MediaConvert::Model::Job::WithJobPercentComplete ( int  value)
inline

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.

Definition at line 525 of file Job.h.

◆ WithJobTemplate() [1/3]

Job& Aws::MediaConvert::Model::Job::WithJobTemplate ( Aws::String &&  value)
inline

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

Definition at line 568 of file Job.h.

◆ WithJobTemplate() [2/3]

Job& Aws::MediaConvert::Model::Job::WithJobTemplate ( const Aws::String value)
inline

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

Definition at line 562 of file Job.h.

◆ WithJobTemplate() [3/3]

Job& Aws::MediaConvert::Model::Job::WithJobTemplate ( const char *  value)
inline

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

Definition at line 574 of file Job.h.

◆ WithMessages() [1/2]

Job& Aws::MediaConvert::Model::Job::WithMessages ( const JobMessages value)
inline

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

Definition at line 605 of file Job.h.

◆ WithMessages() [2/2]

Job& Aws::MediaConvert::Model::Job::WithMessages ( JobMessages &&  value)
inline

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

Definition at line 611 of file Job.h.

◆ WithOutputGroupDetails() [1/2]

Job& Aws::MediaConvert::Model::Job::WithOutputGroupDetails ( Aws::Vector< OutputGroupDetail > &&  value)
inline

List of output group details

Definition at line 642 of file Job.h.

◆ WithOutputGroupDetails() [2/2]

Job& Aws::MediaConvert::Model::Job::WithOutputGroupDetails ( const Aws::Vector< OutputGroupDetail > &  value)
inline

List of output group details

Definition at line 637 of file Job.h.

◆ WithPriority()

Job& Aws::MediaConvert::Model::Job::WithPriority ( int  value)
inline

Relative priority on the job.

Definition at line 673 of file Job.h.

◆ WithQueue() [1/3]

Job& Aws::MediaConvert::Model::Job::WithQueue ( Aws::String &&  value)
inline

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

Definition at line 730 of file Job.h.

◆ WithQueue() [2/3]

Job& Aws::MediaConvert::Model::Job::WithQueue ( const Aws::String value)
inline

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

Definition at line 722 of file Job.h.

◆ WithQueue() [3/3]

Job& Aws::MediaConvert::Model::Job::WithQueue ( const char *  value)
inline

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

Definition at line 738 of file Job.h.

◆ WithQueueTransitions() [1/2]

Job& Aws::MediaConvert::Model::Job::WithQueueTransitions ( Aws::Vector< QueueTransition > &&  value)
inline

The job's queue hopping history.

Definition at line 769 of file Job.h.

◆ WithQueueTransitions() [2/2]

Job& Aws::MediaConvert::Model::Job::WithQueueTransitions ( const Aws::Vector< QueueTransition > &  value)
inline

The job's queue hopping history.

Definition at line 764 of file Job.h.

◆ WithRetryCount()

Job& Aws::MediaConvert::Model::Job::WithRetryCount ( int  value)
inline

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

Definition at line 804 of file Job.h.

◆ WithRole() [1/3]

Job& Aws::MediaConvert::Model::Job::WithRole ( Aws::String &&  value)
inline

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

Definition at line 854 of file Job.h.

◆ WithRole() [2/3]

Job& Aws::MediaConvert::Model::Job::WithRole ( const Aws::String value)
inline

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

Definition at line 847 of file Job.h.

◆ WithRole() [3/3]

Job& Aws::MediaConvert::Model::Job::WithRole ( const char *  value)
inline

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

Definition at line 861 of file Job.h.

◆ WithSettings() [1/2]

Job& Aws::MediaConvert::Model::Job::WithSettings ( const JobSettings value)
inline

JobSettings contains all the transcode settings for a job.

Definition at line 887 of file Job.h.

◆ WithSettings() [2/2]

Job& Aws::MediaConvert::Model::Job::WithSettings ( JobSettings &&  value)
inline

JobSettings contains all the transcode settings for a job.

Definition at line 892 of file Job.h.

◆ WithSimulateReservedQueue() [1/2]

Job& Aws::MediaConvert::Model::Job::WithSimulateReservedQueue ( const SimulateReservedQueue value)
inline

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.

Definition at line 933 of file Job.h.

◆ WithSimulateReservedQueue() [2/2]

Job& Aws::MediaConvert::Model::Job::WithSimulateReservedQueue ( SimulateReservedQueue &&  value)
inline

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.

Definition at line 941 of file Job.h.

◆ WithStatus() [1/2]

Job& Aws::MediaConvert::Model::Job::WithStatus ( const JobStatus value)
inline

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

Definition at line 967 of file Job.h.

◆ WithStatus() [2/2]

Job& Aws::MediaConvert::Model::Job::WithStatus ( JobStatus &&  value)
inline

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

Definition at line 972 of file Job.h.

◆ WithStatusUpdateInterval() [1/2]

Job& Aws::MediaConvert::Model::Job::WithStatusUpdateInterval ( const StatusUpdateInterval value)
inline

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.

Definition at line 1013 of file Job.h.

◆ WithStatusUpdateInterval() [2/2]

Job& Aws::MediaConvert::Model::Job::WithStatusUpdateInterval ( StatusUpdateInterval &&  value)
inline

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.

Definition at line 1021 of file Job.h.

◆ WithTiming() [1/2]

Job& Aws::MediaConvert::Model::Job::WithTiming ( const Timing value)
inline

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

Definition at line 1052 of file Job.h.

◆ WithTiming() [2/2]

Job& Aws::MediaConvert::Model::Job::WithTiming ( Timing &&  value)
inline

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

Definition at line 1058 of file Job.h.

◆ WithUserMetadata() [1/2]

Job& Aws::MediaConvert::Model::Job::WithUserMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 1095 of file Job.h.

◆ WithUserMetadata() [2/2]

Job& Aws::MediaConvert::Model::Job::WithUserMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 1089 of file Job.h.


The documentation for this class was generated from the following file: