Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticTranscoder.Types.Job

Description

Synopsis

data Job = Job' {
- arn :: Maybe Text
- id :: Maybe Text
- input :: Maybe JobInput
- inputs :: Maybe [JobInput]
- output :: Maybe JobOutput
- outputKeyPrefix :: Maybe Text
- outputs :: Maybe [JobOutput]
- pipelineId :: Maybe Text
- playlists :: Maybe [Playlist]
- status :: Maybe Text
- timing :: Maybe Timing
- userMetadata :: Maybe (HashMap Text Text)
}
newJob :: Job
job_arn :: Lens' Job (Maybe Text)
job_id :: Lens' Job (Maybe Text)
job_input :: Lens' Job (Maybe JobInput)
job_inputs :: Lens' Job (Maybe [JobInput])
job_output :: Lens' Job (Maybe JobOutput)
job_outputKeyPrefix :: Lens' Job (Maybe Text)
job_outputs :: Lens' Job (Maybe [JobOutput])
job_pipelineId :: Lens' Job (Maybe Text)
job_playlists :: Lens' Job (Maybe [Playlist])
job_status :: Lens' Job (Maybe Text)
job_timing :: Lens' Job (Maybe Timing)
job_userMetadata :: Lens' Job (Maybe (HashMap Text Text))

Documentation

data Job Source #

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

See: newJob smart constructor.

Constructors

Job'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) for the job.
id :: Maybe Text
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
input :: Maybe JobInput
A section of the request or response body that provides information about the file that is being transcoded.
inputs :: Maybe [JobInput]
Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.
output :: Maybe JobOutput
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Outputs recommended instead.
A section of the request or response body that provides information about the transcoded (target) file.
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. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.
outputs :: Maybe [JobOutput]
Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.
If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
pipelineId :: Maybe 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.
playlists :: Maybe [Playlist]
Outputs in Fragmented MP4 or MPEG-TS format only.
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.
status :: Maybe Text
The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
timing :: Maybe Timing
Details about the timing of a job.
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.
Metadata keys and values must use characters from the following list:
- ```
0-9
```
- A-Z and a-z
- ```
Space
```
- The following symbols: _.:/=+-%@

Instances

Instances details

FromJSON Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods parseJSON :: Value -> Parser Job # parseJSONList :: Value -> Parser [Job] #
Generic Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Associated Types type Rep Job :: Type -> Type # Methods from :: Job -> Rep Job x # to :: Rep Job x -> Job #
Read Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods readsPrec :: Int -> ReadS Job # readList :: ReadS [Job] # readPrec :: ReadPrec Job # readListPrec :: ReadPrec [Job] #
Show Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods showsPrec :: Int -> Job -> ShowS # show :: Job -> String # showList :: [Job] -> ShowS #
NFData Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods rnf :: Job -> () #
Eq Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods (==) :: Job -> Job -> Bool # (/=) :: Job -> Job -> Bool #
Hashable Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job Methods hashWithSalt :: Int -> Job -> Int # hash :: Job -> Int #
type Rep Job Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.ElasticTranscoder.Types.Job" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobInput)))) :: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobInput])) :: (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobOutput)) :: S1 ('MetaSel ('Just "outputKeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobOutput])) :: (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "playlists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Playlist])))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Timing)) :*: S1 ('MetaSel ('Just "userMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))))

newJob :: Job Source #

Create a value of Job 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:arn:Job', job_arn - The Amazon Resource Name (ARN) for the job.

Job, job_id - The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

$sel:input:Job', job_input - A section of the request or response body that provides information about the file that is being transcoded.

$sel:inputs:Job', job_inputs - Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

$sel:output:Job', job_output - If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead.

A section of the request or response body that provides information about the transcoded (target) file.

$sel:outputKeyPrefix:Job', job_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. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

$sel:outputs:Job', job_outputs - Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

$sel:pipelineId:Job', job_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.

$sel:playlists:Job', job_playlists - Outputs in Fragmented MP4 or MPEG-TS format only.

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.

Job, job_status - The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

$sel:timing:Job', job_timing - Details about the timing of a job.

$sel:userMetadata:Job', job_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.

Metadata keys and values must use characters from the following list:

```
0-9
```
A-Z and a-z
```
Space
```
The following symbols: _.:/=+-%@

job_arn :: Lens' Job (Maybe Text) Source #

The Amazon Resource Name (ARN) for the job.

job_id :: Lens' Job (Maybe Text) Source #

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

job_input :: Lens' Job (Maybe JobInput) Source #

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

job_inputs :: Lens' Job (Maybe [JobInput]) Source #

Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

job_output :: Lens' Job (Maybe JobOutput) Source #

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead.

A section of the request or response body that provides information about the transcoded (target) file.

job_outputKeyPrefix :: Lens' Job (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. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

job_outputs :: Lens' Job (Maybe [JobOutput]) Source #

Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

job_pipelineId :: Lens' Job (Maybe 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.

job_playlists :: Lens' Job (Maybe [Playlist]) Source #

Outputs in Fragmented MP4 or MPEG-TS format only.

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.

job_status :: Lens' Job (Maybe Text) Source #

The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

job_timing :: Lens' Job (Maybe Timing) Source #

Details about the timing of a job.

job_userMetadata :: Lens' Job (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.

Metadata keys and values must use characters from the following list:

```
0-9
```
A-Z and a-z
```
Space
```
The following symbols: _.:/=+-%@