createJob method

Future<CreateJobResponse> createJob({ required String pipelineId, JobInput? input, List<JobInput>? inputs, CreateJobOutput? output, String? outputKeyPrefix, List<CreateJobOutput>? outputs, List<CreateJobPlaylist>? playlists, Map<String, String>? userMetadata, })

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

May throw ValidationException. May throw IncompatibleVersionException. May throw ResourceNotFoundException. May throw AccessDeniedException. May throw LimitExceededException. May throw InternalServiceException.

Parameter pipelineId : The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

Parameter input : A section of the request body that provides information about the file that is being transcoded.

Parameter inputs : A section of the request body that provides information about the files that are being transcoded.

Parameter output : A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

Parameter outputKeyPrefix : The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

Parameter outputs : A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

Parameter playlists : If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

Parameter userMetadata : User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

Implementation

Future<CreateJobResponse> createJob({
  required String pipelineId,
  JobInput? input,
  List<JobInput>? inputs,
  CreateJobOutput? output,
  String? outputKeyPrefix,
  List<CreateJobOutput>? outputs,
  List<CreateJobPlaylist>? playlists,
  Map<String, String>? userMetadata,
}) async {
  ArgumentError.checkNotNull(pipelineId, 'pipelineId');
  _s.validateStringLength(
    'outputKeyPrefix',
    outputKeyPrefix,
    1,
    255,
  );
  final $payload = <String, dynamic>{
    'PipelineId': pipelineId,
    if (input != null) 'Input': input,
    if (inputs != null) 'Inputs': inputs,
    if (output != null) 'Output': output,
    if (outputKeyPrefix != null) 'OutputKeyPrefix': outputKeyPrefix,
    if (outputs != null) 'Outputs': outputs,
    if (playlists != null) 'Playlists': playlists,
    if (userMetadata != null) 'UserMetadata': userMetadata,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/2012-09-25/jobs',
    exceptionFnMap: _exceptionFns,
  );
  return CreateJobResponse.fromJson(response);
}