Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElasticTranscoder.CreateJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Synopsis

data CreateJob = CreateJob' {
- inputs :: Maybe [JobInput]
- input :: Maybe JobInput
- userMetadata :: Maybe (HashMap Text Text)
- outputs :: Maybe [CreateJobOutput]
- output :: Maybe CreateJobOutput
- playlists :: Maybe [CreateJobPlaylist]
- outputKeyPrefix :: Maybe Text
- pipelineId :: Text
}
newCreateJob :: Text -> CreateJob
createJob_inputs :: Lens' CreateJob (Maybe [JobInput])
createJob_input :: Lens' CreateJob (Maybe JobInput)
createJob_userMetadata :: Lens' CreateJob (Maybe (HashMap Text Text))
createJob_outputs :: Lens' CreateJob (Maybe [CreateJobOutput])
createJob_output :: Lens' CreateJob (Maybe CreateJobOutput)
createJob_playlists :: Lens' CreateJob (Maybe [CreateJobPlaylist])
createJob_outputKeyPrefix :: Lens' CreateJob (Maybe Text)
createJob_pipelineId :: Lens' CreateJob Text
data CreateJobResponse = CreateJobResponse' {
- job :: Maybe Job
- httpStatus :: Int
}
newCreateJobResponse :: Int -> CreateJobResponse
createJobResponse_job :: Lens' CreateJobResponse (Maybe Job)
createJobResponse_httpStatus :: Lens' CreateJobResponse Int

Creating a Request

data CreateJob Source #

The CreateJobRequest structure.

See: newCreateJob smart constructor.

Constructors

CreateJob'

Fields

inputs :: Maybe [JobInput]
A section of the request body that provides information about the files that are being transcoded.
input :: Maybe JobInput
A section of the request body that provides information about the file that is being transcoded.
userMetadata :: Maybe (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.
outputs :: Maybe [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.
output :: 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.
playlists :: Maybe [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.
outputKeyPrefix :: 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.
pipelineId :: 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.

Instances

Instances details

Eq CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods (==) :: CreateJob -> CreateJob -> Bool # (/=) :: CreateJob -> CreateJob -> Bool #
Read CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods readsPrec :: Int -> ReadS CreateJob # readList :: ReadS [CreateJob] # readPrec :: ReadPrec CreateJob # readListPrec :: ReadPrec [CreateJob] #
Show CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods showsPrec :: Int -> CreateJob -> ShowS # show :: CreateJob -> String # showList :: [CreateJob] -> ShowS #
Generic CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Associated Types type Rep CreateJob :: Type -> Type # Methods from :: CreateJob -> Rep CreateJob x # to :: Rep CreateJob x -> CreateJob #
NFData CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods rnf :: CreateJob -> () #
Hashable CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods hashWithSalt :: Int -> CreateJob -> Int # hash :: CreateJob -> Int #
ToJSON CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods toJSON :: CreateJob -> Value # toEncoding :: CreateJob -> Encoding # toJSONList :: [CreateJob] -> Value # toEncodingList :: [CreateJob] -> Encoding #
AWSRequest CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Associated Types type AWSResponse CreateJob # Methods request :: CreateJob -> Request CreateJob # response :: MonadResource m => Logger -> Service -> Proxy CreateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJob))) #
ToHeaders CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods toHeaders :: CreateJob -> [Header] #
ToPath CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods toPath :: CreateJob -> ByteString #
ToQuery CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods toQuery :: CreateJob -> QueryString #
type Rep CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob type Rep CreateJob = D1 ('MetaData "CreateJob" "Amazonka.ElasticTranscoder.CreateJob" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "CreateJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobInput])) :: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobInput))) :: (S1 ('MetaSel ('Just "userMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreateJobOutput])))) :: ((S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateJobOutput)) :: S1 ('MetaSel ('Just "playlists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreateJobPlaylist]))) :: (S1 ('MetaSel ('Just "outputKeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateJob Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob type AWSResponse CreateJob = CreateJobResponse

newCreateJob Source #

Arguments

:: Text	`$sel:pipelineId:CreateJob'`
-> CreateJob

Create a value of CreateJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inputs:CreateJob', createJob_inputs - A section of the request body that provides information about the files that are being transcoded.

$sel:input:CreateJob', createJob_input - A section of the request body that provides information about the file that is being transcoded.

$sel:userMetadata:CreateJob', createJob_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.

$sel:outputs:CreateJob', createJob_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.

$sel:output:CreateJob', createJob_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.

$sel:playlists:CreateJob', createJob_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.

$sel:outputKeyPrefix:CreateJob', createJob_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.

$sel:pipelineId:CreateJob', createJob_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.

Request Lenses

createJob_inputs :: Lens' CreateJob (Maybe [JobInput]) Source #

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

createJob_input :: Lens' CreateJob (Maybe JobInput) Source #

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

createJob_userMetadata :: Lens' CreateJob (Maybe (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 are returned in the same order in which you specify them.

createJob_outputs :: Lens' CreateJob (Maybe [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.

createJob_output :: Lens' CreateJob (Maybe CreateJobOutput) Source #

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.

createJob_playlists :: Lens' CreateJob (Maybe [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.

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

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

Destructuring the Response

data CreateJobResponse Source #

The CreateJobResponse structure.

See: newCreateJobResponse smart constructor.

Constructors

CreateJobResponse'
Fields job :: Maybe Job A section of the response body that provides information about the job that is created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods (==) :: CreateJobResponse -> CreateJobResponse -> Bool # (/=) :: CreateJobResponse -> CreateJobResponse -> Bool #
Read CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods readsPrec :: Int -> ReadS CreateJobResponse # readList :: ReadS [CreateJobResponse] # readPrec :: ReadPrec CreateJobResponse # readListPrec :: ReadPrec [CreateJobResponse] #
Show CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods showsPrec :: Int -> CreateJobResponse -> ShowS # show :: CreateJobResponse -> String # showList :: [CreateJobResponse] -> ShowS #
Generic CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Associated Types type Rep CreateJobResponse :: Type -> Type # Methods from :: CreateJobResponse -> Rep CreateJobResponse x # to :: Rep CreateJobResponse x -> CreateJobResponse #
NFData CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob Methods rnf :: CreateJobResponse -> () #
type Rep CreateJobResponse Source #
Instance details Defined in Amazonka.ElasticTranscoder.CreateJob type Rep CreateJobResponse = D1 ('MetaData "CreateJobResponse" "Amazonka.ElasticTranscoder.CreateJob" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "CreateJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Job)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateJobResponse'`
-> CreateJobResponse

Create a value of CreateJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:job:CreateJobResponse', createJobResponse_job - A section of the response body that provides information about the job that is created.

$sel:httpStatus:CreateJobResponse', createJobResponse_httpStatus - The response's http status code.

Response Lenses

createJobResponse_job :: Lens' CreateJobResponse (Maybe Job) Source #

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

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.