Important Notes - AWS Elemental MediaConvert API Reference
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

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

FIPS Endpoints

Unlike standard AWS endpoints, FIPS endpoints use a TLS software library that complies with Federal Information Processing Standards (FIPS). Enterprises that interact with the United States government might require FIPS endpoints.

You get a MediaConvert FIPS endpoint in the same way that you get a standard account-specific endpoint. The only difference is that you call DescribeEndpoints on a FIPS-enabled MediaConvert subscription endpoint. MediaConvert will return an account-specific FIPS endpoint that you can use to interact with the service.

Important

If you request your account-specific FIPS endpoint programmatically, do so only once. Don't make a request to this endpoint each time that you make a request to MediaConvert. Otherwise, you will reach the throttle maximum on the subscription endpoint.

To request an account-specific FIPS endpoint using the AWS CLI, use the following command.

aws mediaconvert --endpoint-url https://mediaconvert-fips.us-east-1.amazonaws.com describe-endpoints

The response is similar to the following example.

{ "Endpoints": [ { "Url": "https://vasjpylpa.mediaconvert-fips.us-east-1.amazonaws.com" } ] }

MediaConvert FIPS-enabled subscription endpoints follow this URL schema: https://mediaconvert-fips.<region>.amazonaws.com.

You can use a MediaConvert FIPS endpoint in us-gov-west-1 and all North American commercial Regions. For a list of the MediaConvert FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-2 in the AWS compliance documentation.

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.