« blib/lib/Paws/ElasticTranscoder/InputCaptions.pm
↑ Summary
blib/lib/Paws/ElasticTranscoder/JobAlbumArt.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ElasticTranscoder::Job; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Id => (is => 'ro', isa => 'Str'); | ||
| 6 | has Input => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobInput'); | ||
| 7 | has Inputs => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobInput]'); | ||
| 8 | has Output => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobOutput'); | ||
| 9 | has OutputKeyPrefix => (is => 'ro', isa => 'Str'); | ||
| 10 | has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobOutput]'); | ||
| 11 | has PipelineId => (is => 'ro', isa => 'Str'); | ||
| 12 | has Playlists => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::Playlist]'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | has Timing => (is => 'ro', isa => 'Paws::ElasticTranscoder::Timing'); | ||
| 15 | has UserMetadata => (is => 'ro', isa => 'Paws::ElasticTranscoder::UserMetadata'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ElasticTranscoder::Job | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Job object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { Arn => $value, ..., UserMetadata => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Job object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Arn | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | A section of the response body that provides information about the job | ||
| 48 | that is created. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Arn => Str | ||
| 54 | |||
| 55 | The Amazon Resource Name (ARN) for the job. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Id => Str | ||
| 59 | |||
| 60 | The identifier that Elastic Transcoder assigned to the job. You use | ||
| 61 | this value to get settings for the job or to delete the job. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Input => L<Paws::ElasticTranscoder::JobInput> | ||
| 65 | |||
| 66 | A section of the request or response body that provides information | ||
| 67 | about the file that is being transcoded. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Inputs => ArrayRef[L<Paws::ElasticTranscoder::JobInput>] | ||
| 71 | |||
| 72 | Information about the files that you're transcoding. If you specified | ||
| 73 | multiple files for this job, Elastic Transcoder stitches the files | ||
| 74 | together to make one output. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Output => L<Paws::ElasticTranscoder::JobOutput> | ||
| 78 | |||
| 79 | If you specified one output for a job, information about that output. | ||
| 80 | If you specified multiple outputs for a job, the Output object lists | ||
| 81 | information about the first output. This duplicates the information | ||
| 82 | that is listed for the first output in the Outputs object. | ||
| 83 | |||
| 84 | Outputs recommended instead. | ||
| 85 | |||
| 86 | A section of the request or response body that provides information | ||
| 87 | about the transcoded (target) file. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 OutputKeyPrefix => Str | ||
| 91 | |||
| 92 | The value, if any, that you want Elastic Transcoder to prepend to the | ||
| 93 | names of all files that this job creates, including output files, | ||
| 94 | thumbnails, and playlists. We recommend that you add a / or some other | ||
| 95 | delimiter to the end of the C<OutputKeyPrefix>. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Outputs => ArrayRef[L<Paws::ElasticTranscoder::JobOutput>] | ||
| 99 | |||
| 100 | Information about the output files. We recommend that you use the | ||
| 101 | C<Outputs> syntax for all jobs, even when you want Elastic Transcoder | ||
| 102 | to transcode a file into only one format. Do not use both the | ||
| 103 | C<Outputs> and C<Output> syntaxes in the same request. You can create a | ||
| 104 | maximum of 30 outputs per job. | ||
| 105 | |||
| 106 | If you specify more than one output for a job, Elastic Transcoder | ||
| 107 | creates the files for each output in the order in which you specify | ||
| 108 | them in the job. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 PipelineId => Str | ||
| 112 | |||
| 113 | The C<Id> of the pipeline that you want Elastic Transcoder to use for | ||
| 114 | transcoding. The pipeline determines several settings, including the | ||
| 115 | Amazon S3 bucket from which Elastic Transcoder gets the files to | ||
| 116 | transcode and the bucket into which Elastic Transcoder puts the | ||
| 117 | transcoded files. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Playlists => ArrayRef[L<Paws::ElasticTranscoder::Playlist>] | ||
| 121 | |||
| 122 | Outputs in Fragmented MP4 or MPEG-TS format only. | ||
| 123 | |||
| 124 | If you specify a preset in C<PresetId> for which the value of | ||
| 125 | C<Container> is fmp4 (Fragmented MP4) or ts (MPEG-TS), C<Playlists> | ||
| 126 | contains information about the master playlists that you want Elastic | ||
| 127 | Transcoder to create. | ||
| 128 | |||
| 129 | The maximum number of master playlists in a job is 30. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 Status => Str | ||
| 133 | |||
| 134 | The status of the job: C<Submitted>, C<Progressing>, C<Complete>, | ||
| 135 | C<Canceled>, or C<Error>. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Timing => L<Paws::ElasticTranscoder::Timing> | ||
| 139 | |||
| 140 | Details about the timing of a job. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 UserMetadata => L<Paws::ElasticTranscoder::UserMetadata> | ||
| 144 | |||
| 145 | User-defined metadata that you want to associate with an Elastic | ||
| 146 | Transcoder job. You specify metadata in C<key/value> pairs, and you can | ||
| 147 | add up to 10 C<key/value> pairs per job. Elastic Transcoder does not | ||
| 148 | guarantee that C<key/value> pairs are returned in the same order in | ||
| 149 | which you specify them. | ||
| 150 | |||
| 151 | Metadata C<keys> and C<values> must use characters from the following | ||
| 152 | list: | ||
| 153 | |||
| 154 | =over | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | C<0-9> | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<A-Z> and C<a-z> | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | C<Space> | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | The following symbols: C<_.:/=+-%@> | ||
| 171 | |||
| 172 | =back | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head1 SEE ALSO | ||
| 178 | |||
| 179 | This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder> | ||
| 180 | |||
| 181 | =head1 BUGS and CONTRIBUTIONS | ||
| 182 | |||
| 183 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 184 | |||
| 185 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 186 | |||
| 187 | =cut | ||
| 188 |