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 |
Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Synopsis
- data CreateJob = CreateJob' {
- jobTemplate :: Maybe Text
- accelerationSettings :: Maybe AccelerationSettings
- priority :: Maybe Int
- statusUpdateInterval :: Maybe StatusUpdateInterval
- hopDestinations :: Maybe [HopDestination]
- simulateReservedQueue :: Maybe SimulateReservedQueue
- queue :: Maybe Text
- userMetadata :: Maybe (HashMap Text Text)
- billingTagsSource :: Maybe BillingTagsSource
- clientRequestToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- role' :: Text
- settings :: JobSettings
- newCreateJob :: Text -> JobSettings -> CreateJob
- createJob_jobTemplate :: Lens' CreateJob (Maybe Text)
- createJob_accelerationSettings :: Lens' CreateJob (Maybe AccelerationSettings)
- createJob_priority :: Lens' CreateJob (Maybe Int)
- createJob_statusUpdateInterval :: Lens' CreateJob (Maybe StatusUpdateInterval)
- createJob_hopDestinations :: Lens' CreateJob (Maybe [HopDestination])
- createJob_simulateReservedQueue :: Lens' CreateJob (Maybe SimulateReservedQueue)
- createJob_queue :: Lens' CreateJob (Maybe Text)
- createJob_userMetadata :: Lens' CreateJob (Maybe (HashMap Text Text))
- createJob_billingTagsSource :: Lens' CreateJob (Maybe BillingTagsSource)
- createJob_clientRequestToken :: Lens' CreateJob (Maybe Text)
- createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text))
- createJob_role :: Lens' CreateJob Text
- createJob_settings :: Lens' CreateJob JobSettings
- 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
See: newCreateJob
smart constructor.
CreateJob' | |
|
Instances
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:jobTemplate:CreateJob'
, createJob_jobTemplate
- Optional. When you create a job, you can either specify a job template
or specify the transcoding settings individually.
$sel:accelerationSettings:CreateJob'
, createJob_accelerationSettings
- Optional. 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:CreateJob'
, createJob_priority
- Optional. 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:CreateJob'
, createJob_statusUpdateInterval
- Optional. 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:hopDestinations:CreateJob'
, createJob_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:simulateReservedQueue:CreateJob'
, createJob_simulateReservedQueue
- Optional. Enable this setting when you run a test job to estimate how
many reserved transcoding slots (RTS) you need. When this is enabled,
MediaConvert runs your job from an on-demand queue with similar
performance to what you will see with one RTS in a reserved queue. This
setting is disabled by default.
$sel:queue:CreateJob'
, createJob_queue
- Optional. When you create a job, you can specify a queue to send it to.
If you don't specify, the job will go to the default queue. For more
about queues, see the User Guide topic at
https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
$sel:userMetadata:CreateJob'
, createJob_userMetadata
- Optional. User-defined metadata that you want to associate with an
MediaConvert job. You specify metadata in key/value pairs. Use only for
existing integrations or workflows that rely on job metadata tags.
Otherwise, we recommend that you use standard AWS tags.
$sel:billingTagsSource:CreateJob'
, createJob_billingTagsSource
- Optional. Choose a tag type that AWS Billing and Cost Management will
use to sort your AWS Elemental MediaConvert costs on any billing report
that you set up. Any transcoding outputs that don't have an associated
tag will appear in your billing report unsorted. If you don't choose a
valid value for this field, your job outputs will appear on the billing
report unsorted.
$sel:clientRequestToken:CreateJob'
, createJob_clientRequestToken
- Optional. Idempotency token for CreateJob operation.
$sel:tags:CreateJob'
, createJob_tags
- Optional. The tags that you want to add to the resource. You can tag
resources with a key-value pair or with only a key. Use standard AWS
tags on your job for automatic integration with AWS services and for
custom integrations and workflows.
$sel:role':CreateJob'
, createJob_role
- Required. The IAM role you use for creating this job. For details about
permissions, see the User Guide topic at the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
$sel:settings:CreateJob'
, createJob_settings
- JobSettings contains all the transcode settings for a job.
Request Lenses
createJob_jobTemplate :: Lens' CreateJob (Maybe Text) Source #
Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
createJob_accelerationSettings :: Lens' CreateJob (Maybe AccelerationSettings) Source #
Optional. 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.
createJob_priority :: Lens' CreateJob (Maybe Int) Source #
Optional. 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.
createJob_statusUpdateInterval :: Lens' CreateJob (Maybe StatusUpdateInterval) Source #
Optional. 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.
createJob_hopDestinations :: Lens' CreateJob (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.
createJob_simulateReservedQueue :: Lens' CreateJob (Maybe SimulateReservedQueue) Source #
Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.
createJob_queue :: Lens' CreateJob (Maybe Text) Source #
Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.
createJob_userMetadata :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #
Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs. Use only for existing integrations or workflows that rely on job metadata tags. Otherwise, we recommend that you use standard AWS tags.
createJob_billingTagsSource :: Lens' CreateJob (Maybe BillingTagsSource) Source #
Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.
createJob_clientRequestToken :: Lens' CreateJob (Maybe Text) Source #
Optional. Idempotency token for CreateJob operation.
createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #
Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key. Use standard AWS tags on your job for automatic integration with AWS services and for custom integrations and workflows.
createJob_role :: Lens' CreateJob Text Source #
Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
createJob_settings :: Lens' CreateJob JobSettings Source #
JobSettings contains all the transcode settings for a job.
Destructuring the Response
data CreateJobResponse Source #
See: newCreateJobResponse
smart constructor.
CreateJobResponse' | |
|
Instances
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
- Each job converts an input file into an output file or files. For more
information, see the User Guide at
https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
$sel:httpStatus:CreateJobResponse'
, createJobResponse_httpStatus
- The response's http status code.
Response Lenses
createJobResponse_job :: Lens' CreateJobResponse (Maybe Job) Source #
Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #
The response's http status code.