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 |
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
- data CreateJobTemplate = CreateJobTemplate' {
- accelerationSettings :: Maybe AccelerationSettings
- category :: Maybe Text
- description :: Maybe Text
- hopDestinations :: Maybe [HopDestination]
- priority :: Maybe Int
- queue :: Maybe Text
- statusUpdateInterval :: Maybe StatusUpdateInterval
- tags :: Maybe (HashMap Text Text)
- settings :: JobTemplateSettings
- name :: Text
- newCreateJobTemplate :: JobTemplateSettings -> Text -> CreateJobTemplate
- createJobTemplate_accelerationSettings :: Lens' CreateJobTemplate (Maybe AccelerationSettings)
- createJobTemplate_category :: Lens' CreateJobTemplate (Maybe Text)
- createJobTemplate_description :: Lens' CreateJobTemplate (Maybe Text)
- createJobTemplate_hopDestinations :: Lens' CreateJobTemplate (Maybe [HopDestination])
- createJobTemplate_priority :: Lens' CreateJobTemplate (Maybe Int)
- createJobTemplate_queue :: Lens' CreateJobTemplate (Maybe Text)
- createJobTemplate_statusUpdateInterval :: Lens' CreateJobTemplate (Maybe StatusUpdateInterval)
- createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe (HashMap Text Text))
- createJobTemplate_settings :: Lens' CreateJobTemplate JobTemplateSettings
- createJobTemplate_name :: Lens' CreateJobTemplate Text
- data CreateJobTemplateResponse = CreateJobTemplateResponse' {}
- newCreateJobTemplateResponse :: Int -> CreateJobTemplateResponse
- createJobTemplateResponse_jobTemplate :: Lens' CreateJobTemplateResponse (Maybe JobTemplate)
- createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int
Creating a Request
data CreateJobTemplate Source #
See: newCreateJobTemplate
smart constructor.
CreateJobTemplate' | |
|
Instances
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:
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.
CreateJobTemplate
, createJobTemplate_category
- Optional. A category for the job template you are creating
CreateJobTemplate
, createJobTemplate_description
- Optional. A description of the job template you are creating.
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.
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.
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.
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.
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.
CreateJobTemplate
, createJobTemplate_settings
- JobTemplateSettings contains all the transcode settings saved in the
template that will be applied to jobs created from it.
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_category :: Lens' CreateJobTemplate (Maybe Text) Source #
Optional. A category for the job template you are creating
createJobTemplate_description :: Lens' CreateJobTemplate (Maybe Text) Source #
Optional. A description of 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_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_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_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_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.
CreateJobTemplateResponse' | |
|
Instances
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:
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.
createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int Source #
The response's http status code.