AWS Elemental MediaConvert API Reference
API Reference

Important Notes

Account-Specific Endpoints

Unlike most AWS services, AWS Elemental MediaConvert requires that you send your requests to an endpoint that is specific to your account. For more information, see Getting Started with MediaConvert Using the API or Getting Started with AWS Elemental MediaConvert Using the AWS SDKs or the AWS CLI.

Versioned Endpoints

When you send requests programmatically, you must specify the API version that you send the requests to. The current API version is 2017-08-29.

Therefore, you must construct your endpoint like this:

https://<account-specific-digits>.mediaconvert.<region>.amazonaws.com/2017-08-29/<resource>/<parameter>

For example:

https://abcd1234.mediaconvert.region-name-1.amazonaws.com/2017-08-29/queues/my-queue

Using the AWS CLI

When you send requests using the AWS CLI, use PascalCase for all properties. For example, if you used the properties settings and timecodeConfig in your API call, you must change those to Settings and TimecodeConfig for your CLI call. This is required because the CLI is built on Python, which uses PascalCase for properties.

Schemas and Example Job Settings

The schemas provided in this guide are not working examples. Instead, they provide information about how to structure your job settings specification. For example job settings in JSON format, see example job settings in the AWS Elemental MediaConvert User Guide. You pass in job settings as the payload when you create jobs, custom output presets, and custom job templates.

If you access AWS Elemental MediaConvert directly through the API, using theAWS CLI, or using the AWS SDK for Python (Boto), you submit your job settings as a JSON file. The simplest way to generate this file is to set up your job using the MediaConvert console and then, on the Create job page, choose Show job JSON.

If you access AWS Elemental MediaConvert through one of the AWS SDKs other than Python, consult the documentation for those SDKs for information about the syntax to use to for your job settings specification. For more information about using the AWS SDKs to access MediaConvert, see Getting Started with AWS Elemental MediaConvert Using the AWS SDKs or the AWS CLI.