Network.AWS.ElasticTranscoder.CreateJob

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).

Creating a Request

createJob

Arguments

:: Text

cjPipelineId

-> CreateJob

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:

• cjInputs - A section of the request body that provides information about the files that are being transcoded.
• cjInput - A section of the request body that provides information about the file that is being transcoded.
• cjUserMetadata - 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.
• cjOutputs - 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.
• cjOutput - 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.
• cjPlaylists - 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 - 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 - 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.

data CreateJob

The CreateJobRequest structure.

See: createJob smart constructor.

Instances

Eq CreateJob

Methods

(==) :: CreateJob -> CreateJob -> Bool

(/=) :: CreateJob -> CreateJob -> Bool

Data CreateJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJob -> c CreateJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJob

toConstr :: CreateJob -> Constr

dataTypeOf :: CreateJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJob)

gmapT :: (forall b. Data b => b -> b) -> CreateJob -> CreateJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

Read CreateJob

Methods

readsPrec :: Int -> ReadS CreateJob

readList :: ReadS [CreateJob]

readPrec :: ReadPrec CreateJob

readListPrec :: ReadPrec [CreateJob]

Show CreateJob

Methods

showsPrec :: Int -> CreateJob -> ShowS

show :: CreateJob -> String

showList :: [CreateJob] -> ShowS

Generic CreateJob

Associated Types

type Rep CreateJob :: * -> *

Methods

from :: CreateJob -> Rep CreateJob x

to :: Rep CreateJob x -> CreateJob

Hashable CreateJob

Methods

hashWithSalt :: Int -> CreateJob -> Int

hash :: CreateJob -> Int

ToJSON CreateJob

Methods

toJSON :: CreateJob -> Value

toEncoding :: CreateJob -> Encoding

toJSONList :: [CreateJob] -> Value

toEncodingList :: [CreateJob] -> Encoding

NFData CreateJob

Methods

rnf :: CreateJob -> ()

AWSRequest CreateJob

Associated Types

type Rs CreateJob :: *

Methods

request :: CreateJob -> Request CreateJob

response :: MonadResource m => Logger -> Service -> Proxy * CreateJob -> ClientResponse -> m (Response CreateJob)

ToPath CreateJob

Methods

toPath :: CreateJob -> ByteString

ToHeaders CreateJob

Methods

toHeaders :: CreateJob -> [Header]

ToQuery CreateJob

Methods

toQuery :: CreateJob -> QueryString

type Rep CreateJob

type Rep CreateJob = D1 (MetaData "CreateJob" "Network.AWS.ElasticTranscoder.CreateJob" "amazonka-elastictranscoder-1.4.5-GpfBhNC18w3LkITq5oXQDr" False) (C1 (MetaCons "CreateJob'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cjInputs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JobInput]))) (S1 (MetaSel (Just Symbol "_cjInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobInput)))) ((:*:) (S1 (MetaSel (Just Symbol "_cjUserMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_cjOutputs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CreateJobOutput]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cjOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CreateJobOutput))) (S1 (MetaSel (Just Symbol "_cjPlaylists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CreateJobPlaylist])))) ((:*:) (S1 (MetaSel (Just Symbol "_cjOutputKeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cjPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateJob

type Rs CreateJob = CreateJobResponse

Request Lenses

cjInputs :: Lens' CreateJob [JobInput]

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

cjInput :: Lens' CreateJob (Maybe JobInput)

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

cjUserMetadata :: Lens' CreateJob (HashMap Text Text)

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.

cjOutputs :: Lens' CreateJob [CreateJobOutput]

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.

cjOutput :: Lens' CreateJob (Maybe CreateJobOutput)

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.

cjPlaylists :: Lens' CreateJob [CreateJobPlaylist]

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)

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

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.

Destructuring the Response

createJobResponse

Arguments

:: Int

cjrsResponseStatus

-> 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:

• cjrsJob - A section of the response body that provides information about the job that is created.
• cjrsResponseStatus - -- | The response status code.

data CreateJobResponse

The CreateJobResponse structure.

See: createJobResponse smart constructor.

Instances

Eq CreateJobResponse

Methods

(==) :: CreateJobResponse -> CreateJobResponse -> Bool

(/=) :: CreateJobResponse -> CreateJobResponse -> Bool

Data CreateJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJobResponse -> c CreateJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJobResponse

toConstr :: CreateJobResponse -> Constr

dataTypeOf :: CreateJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJobResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateJobResponse -> CreateJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

Read CreateJobResponse

Methods

readsPrec :: Int -> ReadS CreateJobResponse

readList :: ReadS [CreateJobResponse]

readPrec :: ReadPrec CreateJobResponse

readListPrec :: ReadPrec [CreateJobResponse]

Show CreateJobResponse

Methods

showsPrec :: Int -> CreateJobResponse -> ShowS

show :: CreateJobResponse -> String

showList :: [CreateJobResponse] -> ShowS

Generic CreateJobResponse

Associated Types

type Rep CreateJobResponse :: * -> *

Methods

from :: CreateJobResponse -> Rep CreateJobResponse x

to :: Rep CreateJobResponse x -> CreateJobResponse

NFData CreateJobResponse

Methods

rnf :: CreateJobResponse -> ()

type Rep CreateJobResponse

type Rep CreateJobResponse = D1 (MetaData "CreateJobResponse" "Network.AWS.ElasticTranscoder.CreateJob" "amazonka-elastictranscoder-1.4.5-GpfBhNC18w3LkITq5oXQDr" False) (C1 (MetaCons "CreateJobResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cjrsJob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Job'))) (S1 (MetaSel (Just Symbol "_cjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cjrsJob :: Lens' CreateJobResponse (Maybe Job')

A section of the response body that provides information about the job that is created.

cjrsResponseStatus :: Lens' CreateJobResponse Int

• - | The response status code.