libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConvert.CreateJobTemplate

Description

Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Synopsis

Creating a Request

data CreateJobTemplate Source #

See: newCreateJobTemplate smart constructor.

Constructors

CreateJobTemplate' 

Fields

  • accelerationSettings :: Maybe AccelerationSettings

    Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.

  • priority :: Maybe Int

    Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.

  • statusUpdateInterval :: Maybe StatusUpdateInterval

    Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

  • category :: Maybe Text

    Optional. A category for the job template you are creating

  • hopDestinations :: Maybe [HopDestination]

    Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.

  • queue :: Maybe Text

    Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.

  • description :: Maybe Text

    Optional. A description of the job template you are creating.

  • tags :: Maybe (HashMap Text Text)

    The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

  • settings :: JobTemplateSettings

    JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

  • name :: Text

    The name of the job template you are creating.

Instances

Instances details
Eq CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Read CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Show CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Generic CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Associated Types

type Rep CreateJobTemplate :: Type -> Type #

NFData CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Methods

rnf :: CreateJobTemplate -> () #

Hashable CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

ToJSON CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

AWSRequest CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Associated Types

type AWSResponse CreateJobTemplate #

ToHeaders CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

ToPath CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

ToQuery CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

type Rep CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

type AWSResponse CreateJobTemplate Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

newCreateJobTemplate Source #

Create a value of CreateJobTemplate 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:accelerationSettings:CreateJobTemplate', createJobTemplate_accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.

$sel:priority:CreateJobTemplate', createJobTemplate_priority - Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.

$sel:statusUpdateInterval:CreateJobTemplate', createJobTemplate_statusUpdateInterval - Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

$sel:category:CreateJobTemplate', createJobTemplate_category - Optional. A category for the job template you are creating

$sel:hopDestinations:CreateJobTemplate', createJobTemplate_hopDestinations - Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.

$sel:queue:CreateJobTemplate', createJobTemplate_queue - Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.

$sel:description:CreateJobTemplate', createJobTemplate_description - Optional. A description of the job template you are creating.

$sel:tags:CreateJobTemplate', createJobTemplate_tags - The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

$sel:settings:CreateJobTemplate', createJobTemplate_settings - JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

$sel:name:CreateJobTemplate', createJobTemplate_name - The name of the job template you are creating.

Request Lenses

createJobTemplate_accelerationSettings :: Lens' CreateJobTemplate (Maybe AccelerationSettings) Source #

Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.

createJobTemplate_priority :: Lens' CreateJobTemplate (Maybe Int) Source #

Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.

createJobTemplate_statusUpdateInterval :: Lens' CreateJobTemplate (Maybe StatusUpdateInterval) Source #

Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.

createJobTemplate_category :: Lens' CreateJobTemplate (Maybe Text) Source #

Optional. A category for the job template you are creating

createJobTemplate_hopDestinations :: Lens' CreateJobTemplate (Maybe [HopDestination]) Source #

Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.

createJobTemplate_queue :: Lens' CreateJobTemplate (Maybe Text) Source #

Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.

createJobTemplate_description :: Lens' CreateJobTemplate (Maybe Text) Source #

Optional. A description of the job template you are creating.

createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe (HashMap Text Text)) Source #

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

createJobTemplate_settings :: Lens' CreateJobTemplate JobTemplateSettings Source #

JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

createJobTemplate_name :: Lens' CreateJobTemplate Text Source #

The name of the job template you are creating.

Destructuring the Response

data CreateJobTemplateResponse Source #

See: newCreateJobTemplateResponse smart constructor.

Constructors

CreateJobTemplateResponse' 

Fields

Instances

Instances details
Eq CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Read CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Show CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Generic CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

Associated Types

type Rep CreateJobTemplateResponse :: Type -> Type #

NFData CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

type Rep CreateJobTemplateResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.CreateJobTemplate

type Rep CreateJobTemplateResponse = D1 ('MetaData "CreateJobTemplateResponse" "Amazonka.MediaConvert.CreateJobTemplate" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "CreateJobTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTemplate)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateJobTemplateResponse Source #

Create a value of CreateJobTemplateResponse 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:jobTemplate:CreateJobTemplateResponse', createJobTemplateResponse_jobTemplate - A job template is a pre-made set of encoding instructions that you can use to quickly create a job.

$sel:httpStatus:CreateJobTemplateResponse', createJobTemplateResponse_httpStatus - The response's http status code.

Response Lenses

createJobTemplateResponse_jobTemplate :: Lens' CreateJobTemplateResponse (Maybe JobTemplate) Source #

A job template is a pre-made set of encoding instructions that you can use to quickly create a job.