Mediaconvert

This page documents function available when using the Mediaconvert module, created with @service Mediaconvert.

Index

Documentation

Main.Mediaconvert.associate_certificateMethod
associate_certificate(arn)
associate_certificate(arn, params::Dict{String,<:Any})

Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert.

Arguments

  • arn: The ARN of the ACM certificate that you want to associate with your MediaConvert resource.
Main.Mediaconvert.cancel_jobMethod
cancel_job(id)
cancel_job(id, params::Dict{String,<:Any})

Permanently cancel a job. Once you have canceled a job, you can't start it again.

Arguments

  • id: The Job ID of the job to be cancelled.
Main.Mediaconvert.create_jobMethod
create_job(role, settings)
create_job(role, settings, params::Dict{String,<:Any})

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

Arguments

  • 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.
  • settings: JobSettings contains all the transcode settings for a job.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "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.
  • "clientRequestToken": Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request token can be any string that includes up to 64 ASCII characters. If you reuse a client request token within one minute of a successful request, the API returns the job details of the original request instead. For more information see https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.
  • "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.
  • "jobTemplate": Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.
  • "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.
  • "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.
  • "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.
  • "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.
  • "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.
  • "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.
Main.Mediaconvert.create_job_templateMethod
create_job_template(name, settings)
create_job_template(name, settings, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the job template you are creating.
  • settings: JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "category": Optional. A category for the job template you are creating
  • "description": Optional. A description of the job template you are creating.
  • "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.
  • "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.
  • "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.
  • "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.
  • "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.
Main.Mediaconvert.create_presetMethod
create_preset(name, settings)
create_preset(name, settings, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the preset you are creating.
  • settings: Settings for preset

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "category": Optional. A category for the preset you are creating.
  • "description": Optional. A description of the preset you are creating.
  • "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.
Main.Mediaconvert.create_queueMethod
create_queue(name)
create_queue(name, params::Dict{String,<:Any})

Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html

Arguments

  • name: The name of the queue that you are creating.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": Optional. A description of the queue that you are creating.
  • "pricingPlan": Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand.
  • "reservationPlanSettings": Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
  • "status": Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.
  • "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.
Main.Mediaconvert.delete_job_templateMethod
delete_job_template(name)
delete_job_template(name, params::Dict{String,<:Any})

Permanently delete a job template you have created.

Arguments

  • name: The name of the job template to be deleted.
Main.Mediaconvert.delete_presetMethod
delete_preset(name)
delete_preset(name, params::Dict{String,<:Any})

Permanently delete a preset you have created.

Arguments

  • name: The name of the preset to be deleted.
Main.Mediaconvert.delete_queueMethod
delete_queue(name)
delete_queue(name, params::Dict{String,<:Any})

Permanently delete a queue you have created.

Arguments

  • name: The name of the queue that you want to delete.
Main.Mediaconvert.describe_endpointsMethod
describe_endpoints()
describe_endpoints(params::Dict{String,<:Any})

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Optional. Max number of endpoints, up to twenty, that will be returned at one time.
  • "mode": Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.
  • "nextToken": Use this string, provided with the response to a previous request, to request the next batch of endpoints.
Main.Mediaconvert.disassociate_certificateMethod
disassociate_certificate(arn)
disassociate_certificate(arn, params::Dict{String,<:Any})

Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource.

Arguments

  • arn: The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.
Main.Mediaconvert.get_jobMethod
get_job(id)
get_job(id, params::Dict{String,<:Any})

Retrieve the JSON for a specific completed transcoding job.

Arguments

  • id: the job ID of the job.
Main.Mediaconvert.get_job_templateMethod
get_job_template(name)
get_job_template(name, params::Dict{String,<:Any})

Retrieve the JSON for a specific job template.

Arguments

  • name: The name of the job template.
Main.Mediaconvert.get_presetMethod
get_preset(name)
get_preset(name, params::Dict{String,<:Any})

Retrieve the JSON for a specific preset.

Arguments

  • name: The name of the preset.
Main.Mediaconvert.get_queueMethod
get_queue(name)
get_queue(name, params::Dict{String,<:Any})

Retrieve the JSON for a specific queue.

Arguments

  • name: The name of the queue that you want information about.
Main.Mediaconvert.list_job_templatesMethod
list_job_templates()
list_job_templates(params::Dict{String,<:Any})

Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "category": Optionally, specify a job template category to limit responses to only job templates from that category.
  • "listBy": Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
  • "maxResults": Optional. Number of job templates, up to twenty, that will be returned at one time.
  • "nextToken": Use this string, provided with the response to a previous request, to request the next batch of job templates.
  • "order": Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
Main.Mediaconvert.list_jobsMethod
list_jobs()
list_jobs(params::Dict{String,<:Any})

Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Optional. Number of jobs, up to twenty, that will be returned at one time.
  • "nextToken": Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
  • "order": Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
  • "queue": Optional. Provide a queue name to get back only jobs from that queue.
  • "status": Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
Main.Mediaconvert.list_presetsMethod
list_presets()
list_presets(params::Dict{String,<:Any})

Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "category": Optionally, specify a preset category to limit responses to only presets from that category.
  • "listBy": Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
  • "maxResults": Optional. Number of presets, up to twenty, that will be returned at one time
  • "nextToken": Use this string, provided with the response to a previous request, to request the next batch of presets.
  • "order": Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
Main.Mediaconvert.list_queuesMethod
list_queues()
list_queues(params::Dict{String,<:Any})

Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "listBy": Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.
  • "maxResults": Optional. Number of queues, up to twenty, that will be returned at one time.
  • "nextToken": Use this string, provided with the response to a previous request, to request the next batch of queues.
  • "order": Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
Main.Mediaconvert.list_tags_for_resourceMethod
list_tags_for_resource(arn)
list_tags_for_resource(arn, params::Dict{String,<:Any})

Retrieve the tags for a MediaConvert resource.

Arguments

  • arn: The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name.
Main.Mediaconvert.put_policyMethod
put_policy(policy)
put_policy(policy, params::Dict{String,<:Any})

Create or change your policy. For more information about policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html

Arguments

  • policy: A policy configures behavior that you allow or disallow for your account. For information about MediaConvert policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Main.Mediaconvert.tag_resourceMethod
tag_resource(arn, tags)
tag_resource(arn, tags, params::Dict{String,<:Any})

Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html

Arguments

  • arn: The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name.
  • 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.
Main.Mediaconvert.untag_resourceMethod
untag_resource(arn)
untag_resource(arn, params::Dict{String,<:Any})

Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html

Arguments

  • arn: The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tagKeys": The keys of the tags that you want to remove from the resource.
Main.Mediaconvert.update_job_templateMethod
update_job_template(name)
update_job_template(name, params::Dict{String,<:Any})

Modify one of your existing job templates.

Arguments

  • name: The name of the job template you are modifying

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "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.
  • "category": The new category for the job template, if you are changing it.
  • "description": The new description for the job template, if you are changing it.
  • "hopDestinations": Optional list of hop destinations.
  • "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.
  • "queue": The new queue for the job template, if you are changing it.
  • "settings": JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
  • "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.
Main.Mediaconvert.update_presetMethod
update_preset(name)
update_preset(name, params::Dict{String,<:Any})

Modify one of your existing presets.

Arguments

  • name: The name of the preset you are modifying.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "category": The new category for the preset, if you are changing it.
  • "description": The new description for the preset, if you are changing it.
  • "settings": Settings for preset
Main.Mediaconvert.update_queueMethod
update_queue(name)
update_queue(name, params::Dict{String,<:Any})

Modify one of your existing queues.

Arguments

  • name: The name of the queue that you are modifying.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new description for the queue, if you are changing it.
  • "reservationPlanSettings": The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.
  • "status": Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.