AWS Elemental MediaConvert 2017-08-29

This page describes the parameters and results for the operations of the
AWS Elemental MediaConvert (2017-08-29), and shows how to use the Aws\MediaConvert\MediaConvertClient
object to call the described operations. This documentation is specific to the
2017-08-29 API version of the service.

Operation Summary

Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

Paginators

Paginators handle automatically iterating over paginated API results. Paginators
are associated with specific API operations, and they accept the parameters
that the corresponding API operation accepts. You can get a paginator from a
client class using
getPaginator($paginatorName, $operationParameters). This client supports
the following paginators:

Parameter Details

Members

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

Type: string

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

Type: string

Idempotency token for CreateJob operation.

JobTemplate

Type: string

When you create a job, you can either specify a job template or specify the transcoding settings individually

Priority

Type: 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.

Queue

Type: string

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 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.

Role

Required: Yes

Type: string

Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.

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

Type: string

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.

UserMetadata

Type: Associative array of custom strings keys (__string) to strings

User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.

Parameter Details

Members

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

Type: string

Optional. A category for the job template you are creating

Description

Type: string

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

Name

Required: Yes

Type: string

The name of the job template you are creating.

Priority

Type: 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.

Queue

Type: string

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.

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

StatusUpdateInterval

Type: string

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

Type: Associative array of custom strings keys (__string) to strings

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

Parameter Details

Members

Description

Type: string

Optional. A description of the queue that you are creating.

Name

Required: Yes

Type: string

The name of the queue that you are creating.

PricingPlan

Type: string

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.

Result Details

Members

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

Parameter Syntax

Parameter Details

Members

MaxResults

Type: int

Optional. Max number of endpoints, up to twenty, that will be returned at one time.

Mode

Type: string

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

Type: string

Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Result Details

Members

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

ListJobTemplates

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

ListJobs

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.

ListPresets

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.

ListQueues

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.

Parameter Details

Members

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

Type: string

The new category for the job template, if you are changing it.

Description

Type: string

The new description for the job template, if you are changing it.

Name

Required: Yes

Type: string

The name of the job template you are modifying

Priority

Type: 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.

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

StatusUpdateInterval

Type: string

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.