« blib/lib/Paws/MediaConvert/InsertableImage.pm
↑ Summary
blib/lib/Paws/MediaConvert/JobMessages.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::Job; | ||
| 3 | use Moose; | ||
| 4 | has AccelerationSettings => (is => 'ro', isa => 'Paws::MediaConvert::AccelerationSettings', request_name => 'accelerationSettings', traits => ['NameInRequest']); | ||
| 5 | has AccelerationStatus => (is => 'ro', isa => 'Str', request_name => 'accelerationStatus', traits => ['NameInRequest']); | ||
| 6 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 7 | has BillingTagsSource => (is => 'ro', isa => 'Str', request_name => 'billingTagsSource', traits => ['NameInRequest']); | ||
| 8 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 9 | has CurrentPhase => (is => 'ro', isa => 'Str', request_name => 'currentPhase', traits => ['NameInRequest']); | ||
| 10 | has ErrorCode => (is => 'ro', isa => 'Int', request_name => 'errorCode', traits => ['NameInRequest']); | ||
| 11 | has ErrorMessage => (is => 'ro', isa => 'Str', request_name => 'errorMessage', traits => ['NameInRequest']); | ||
| 12 | has HopDestinations => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::HopDestination]', request_name => 'hopDestinations', traits => ['NameInRequest']); | ||
| 13 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 14 | has JobPercentComplete => (is => 'ro', isa => 'Int', request_name => 'jobPercentComplete', traits => ['NameInRequest']); | ||
| 15 | has JobTemplate => (is => 'ro', isa => 'Str', request_name => 'jobTemplate', traits => ['NameInRequest']); | ||
| 16 | has Messages => (is => 'ro', isa => 'Paws::MediaConvert::JobMessages', request_name => 'messages', traits => ['NameInRequest']); | ||
| 17 | has OutputGroupDetails => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::OutputGroupDetail]', request_name => 'outputGroupDetails', traits => ['NameInRequest']); | ||
| 18 | has Priority => (is => 'ro', isa => 'Int', request_name => 'priority', traits => ['NameInRequest']); | ||
| 19 | has Queue => (is => 'ro', isa => 'Str', request_name => 'queue', traits => ['NameInRequest']); | ||
| 20 | has QueueTransitions => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::QueueTransition]', request_name => 'queueTransitions', traits => ['NameInRequest']); | ||
| 21 | has RetryCount => (is => 'ro', isa => 'Int', request_name => 'retryCount', traits => ['NameInRequest']); | ||
| 22 | has Role => (is => 'ro', isa => 'Str', request_name => 'role', traits => ['NameInRequest'], required => 1); | ||
| 23 | has Settings => (is => 'ro', isa => 'Paws::MediaConvert::JobSettings', request_name => 'settings', traits => ['NameInRequest'], required => 1); | ||
| 24 | has SimulateReservedQueue => (is => 'ro', isa => 'Str', request_name => 'simulateReservedQueue', traits => ['NameInRequest']); | ||
| 25 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 26 | has StatusUpdateInterval => (is => 'ro', isa => 'Str', request_name => 'statusUpdateInterval', traits => ['NameInRequest']); | ||
| 27 | has Timing => (is => 'ro', isa => 'Paws::MediaConvert::Timing', request_name => 'timing', traits => ['NameInRequest']); | ||
| 28 | has UserMetadata => (is => 'ro', isa => 'Paws::MediaConvert::__mapOf__string', request_name => 'userMetadata', traits => ['NameInRequest']); | ||
| 29 | |||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::MediaConvert::Job | ||
| 37 | |||
| 38 | =head1 USAGE | ||
| 39 | |||
| 40 | This class represents one of two things: | ||
| 41 | |||
| 42 | =head3 Arguments in a call to a service | ||
| 43 | |||
| 44 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 45 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 46 | |||
| 47 | As an example, if Att1 is expected to be a Paws::MediaConvert::Job object: | ||
| 48 | |||
| 49 | $service_obj->Method(Att1 => { AccelerationSettings => $value, ..., UserMetadata => $value }); | ||
| 50 | |||
| 51 | =head3 Results returned from an API call | ||
| 52 | |||
| 53 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::Job object: | ||
| 54 | |||
| 55 | $result = $service_obj->Method(...); | ||
| 56 | $result->Att1->AccelerationSettings | ||
| 57 | |||
| 58 | =head1 DESCRIPTION | ||
| 59 | |||
| 60 | Each job converts an input file into an output file or files. For more | ||
| 61 | information, see the User Guide at | ||
| 62 | https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 AccelerationSettings => L<Paws::MediaConvert::AccelerationSettings> | ||
| 68 | |||
| 69 | Accelerated transcoding can significantly speed up jobs with long, | ||
| 70 | visually complex content. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AccelerationStatus => Str | ||
| 74 | |||
| 75 | Describes whether the current job is running with accelerated | ||
| 76 | transcoding. For jobs that have Acceleration (AccelerationMode) set to | ||
| 77 | DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that | ||
| 78 | have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, | ||
| 79 | AccelerationStatus is one of the other states. AccelerationStatus is | ||
| 80 | IN_PROGRESS initially, while the service determines whether the input | ||
| 81 | files and job settings are compatible with accelerated transcoding. If | ||
| 82 | they are, AcclerationStatus is ACCELERATED. If your input files and job | ||
| 83 | settings aren't compatible with accelerated transcoding, the service | ||
| 84 | either fails your job or runs it without accelerated transcoding, | ||
| 85 | depending on how you set Acceleration (AccelerationMode). When the | ||
| 86 | service runs your job without accelerated transcoding, | ||
| 87 | AccelerationStatus is NOT_ACCELERATED. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Arn => Str | ||
| 91 | |||
| 92 | An identifier for this resource that is unique within all of AWS. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 BillingTagsSource => Str | ||
| 96 | |||
| 97 | The tag type that AWS Billing and Cost Management will use to sort your | ||
| 98 | AWS Elemental MediaConvert costs on any billing report that you set up. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 CreatedAt => Str | ||
| 102 | |||
| 103 | The time, in Unix epoch format in seconds, when the job got created. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 CurrentPhase => Str | ||
| 107 | |||
| 108 | A job's phase can be PROBING, TRANSCODING OR UPLOADING | ||
| 109 | |||
| 110 | |||
| 111 | =head2 ErrorCode => Int | ||
| 112 | |||
| 113 | Error code for the job | ||
| 114 | |||
| 115 | |||
| 116 | =head2 ErrorMessage => Str | ||
| 117 | |||
| 118 | Error message of Job | ||
| 119 | |||
| 120 | |||
| 121 | =head2 HopDestinations => ArrayRef[L<Paws::MediaConvert::HopDestination>] | ||
| 122 | |||
| 123 | Optional list of hop destinations. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Id => Str | ||
| 127 | |||
| 128 | A portion of the job's ARN, unique within your AWS Elemental | ||
| 129 | MediaConvert resources | ||
| 130 | |||
| 131 | |||
| 132 | =head2 JobPercentComplete => Int | ||
| 133 | |||
| 134 | An estimate of how far your job has progressed. This estimate is shown | ||
| 135 | as a percentage of the total time from when your job leaves its queue | ||
| 136 | to when your output files appear in your output Amazon S3 bucket. AWS | ||
| 137 | Elemental MediaConvert provides jobPercentComplete in CloudWatch | ||
| 138 | STATUS_UPDATE events and in the response to GetJob and ListJobs | ||
| 139 | requests. The jobPercentComplete estimate is reliable for the following | ||
| 140 | input containers: Quicktime, Transport Stream, MP4, and MXF. For some | ||
| 141 | jobs, the service can't provide information about job progress. In | ||
| 142 | those cases, jobPercentComplete returns a null value. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 JobTemplate => Str | ||
| 146 | |||
| 147 | The job template that the job is created from, if it is created from a | ||
| 148 | job template. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 Messages => L<Paws::MediaConvert::JobMessages> | ||
| 152 | |||
| 153 | Provides messages from the service about jobs that you have already | ||
| 154 | successfully submitted. | ||
| 155 | |||
| 156 | |||
| 157 | =head2 OutputGroupDetails => ArrayRef[L<Paws::MediaConvert::OutputGroupDetail>] | ||
| 158 | |||
| 159 | List of output group details | ||
| 160 | |||
| 161 | |||
| 162 | =head2 Priority => Int | ||
| 163 | |||
| 164 | Relative priority on the job. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 Queue => Str | ||
| 168 | |||
| 169 | When you create a job, you can specify a queue to send it to. If you | ||
| 170 | don't specify, the job will go to the default queue. For more about | ||
| 171 | queues, see the User Guide topic at | ||
| 172 | https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html | ||
| 173 | |||
| 174 | |||
| 175 | =head2 QueueTransitions => ArrayRef[L<Paws::MediaConvert::QueueTransition>] | ||
| 176 | |||
| 177 | The job's queue hopping history. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 RetryCount => Int | ||
| 181 | |||
| 182 | The number of times that the service automatically attempted to process | ||
| 183 | your job after encountering an error. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 B<REQUIRED> Role => Str | ||
| 187 | |||
| 188 | The IAM role you use for creating this job. For details about | ||
| 189 | permissions, see the User Guide topic at the User Guide at | ||
| 190 | https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html | ||
| 191 | |||
| 192 | |||
| 193 | =head2 B<REQUIRED> Settings => L<Paws::MediaConvert::JobSettings> | ||
| 194 | |||
| 195 | JobSettings contains all the transcode settings for a job. | ||
| 196 | |||
| 197 | |||
| 198 | =head2 SimulateReservedQueue => Str | ||
| 199 | |||
| 200 | Enable this setting when you run a test job to estimate how many | ||
| 201 | reserved transcoding slots (RTS) you need. When this is enabled, | ||
| 202 | MediaConvert runs your job from an on-demand queue with similar | ||
| 203 | performance to what you will see with one RTS in a reserved queue. This | ||
| 204 | setting is disabled by default. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 Status => Str | ||
| 208 | |||
| 209 | A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or | ||
| 210 | ERROR. | ||
| 211 | |||
| 212 | |||
| 213 | =head2 StatusUpdateInterval => Str | ||
| 214 | |||
| 215 | Specify how often MediaConvert sends STATUS_UPDATE events to Amazon | ||
| 216 | CloudWatch Events. Set the interval, in seconds, between status | ||
| 217 | updates. MediaConvert sends an update at this interval from the time | ||
| 218 | the service begins processing your job to the time it completes the | ||
| 219 | transcode or encounters an error. | ||
| 220 | |||
| 221 | |||
| 222 | =head2 Timing => L<Paws::MediaConvert::Timing> | ||
| 223 | |||
| 224 | Information about when jobs are submitted, started, and finished is | ||
| 225 | specified in Unix epoch format in seconds. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 UserMetadata => L<Paws::MediaConvert::__mapOf__string> | ||
| 229 | |||
| 230 | User-defined metadata that you want to associate with an MediaConvert | ||
| 231 | job. You specify metadata in key/value pairs. | ||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | =head1 SEE ALSO | ||
| 236 | |||
| 237 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 238 | |||
| 239 | =head1 BUGS and CONTRIBUTIONS | ||
| 240 | |||
| 241 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 242 | |||
| 243 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 244 | |||
| 245 | =cut | ||
| 246 |