| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.ElasticTranscoder.CreateJob
Description
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).
See: AWS API Reference for CreateJob.
- createJob :: Text -> JobInput -> CreateJob
- data CreateJob
- cjUserMetadata :: Lens' CreateJob (HashMap Text Text)
- cjOutputs :: Lens' CreateJob [CreateJobOutput]
- cjOutput :: Lens' CreateJob (Maybe CreateJobOutput)
- cjPlaylists :: Lens' CreateJob [CreateJobPlaylist]
- cjOutputKeyPrefix :: Lens' CreateJob (Maybe Text)
- cjPipelineId :: Lens' CreateJob Text
- cjInput :: Lens' CreateJob JobInput
- createJobResponse :: Int -> CreateJobResponse
- data CreateJobResponse
- cjrsJob :: Lens' CreateJobResponse (Maybe Job')
- cjrsResponseStatus :: Lens' CreateJobResponse Int
Creating a Request
Creates a value of CreateJob with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
The CreateJobRequest structure.
See: createJob smart constructor.
Instances
Request Lenses
cjUserMetadata :: Lens' CreateJob (HashMap Text Text) Source
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 will be returned in the same order in which you specify them.
cjOutputs :: Lens' CreateJob [CreateJobOutput] Source
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.
cjPlaylists :: Lens' CreateJob [CreateJobPlaylist] Source
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.
cjOutputKeyPrefix :: Lens' CreateJob (Maybe Text) Source
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.
cjPipelineId :: Lens' CreateJob Text Source
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.
cjInput :: Lens' CreateJob JobInput Source
A section of the request body that provides information about the file that is being transcoded.
Destructuring the Response
Arguments
| :: Int | |
| -> CreateJobResponse |
Creates a value of CreateJobResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateJobResponse Source
The CreateJobResponse structure.
See: createJobResponse smart constructor.
Response Lenses
cjrsJob :: Lens' CreateJobResponse (Maybe Job') Source
A section of the response body that provides information about the job that is created.
cjrsResponseStatus :: Lens' CreateJobResponse Int Source
The response status code.