Getting Started with MediaConvert Using the API - AWS Elemental MediaConvert API Reference

Getting Started with MediaConvert Using the API

This section shows you how to get started with the MediaConvert API to transcode media files using API calls.

Important

Unlike most AWS services, AWS Elemental MediaConvert requires that you send your requests to an endpoint that is specific to your account. Use the following steps to get going.

To get set up to use the AWS Elemental MediaConvert API

  1. Set up permissions:

    • Permissions that the AWS Elemental MediaConvert service can assume on your behalf. These allow access to your Amazon S3 buckets and to Amazon API Gateway. For instructions, see Set Up IAM Permissions in the AWS Elemental MediaConvert User Guide.

    • Your Signature Version 4 authentication for the requests that you send to AWS. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs, these tools automatically sign the requests for you with the access key and secret key that you specify in your client configuration.

  2. Set up S3 file locations.

    The service reads your input files from and saves your output files to Amazon S3 buckets. For instructions on creating these buckets, see Create Storage for Files in the AWS Elemental MediaConvert User Guide.

  3. Request your account endpoint.

    Send a POST request with an empty body to the following endpoint, replacing <region> with the name of your region. Usually, this is the region where you store your input and output files. This region must match the region that you set up in your client configuration:

    https://mediaconvert.<region>.amazonaws.com/2017-08-29/endpoints

    For example, for the region ap-southeast-2, the endpoint is the following:

    https://mediaconvert.ap-southeast-2.amazonaws.com/2017-08-29/endpoints

    For a full list of MediaConvert public endpoints, see AWS Elemental MediaConvert Regions and Endpoints.

    For information about MediaConvert FIPS endpoints, see FIPS Endpoints.

    The service returns an endpoint similar to "https://abcd1234.mediaconvert.us-west-1.amazonaws.com". The first eight digits after "https://" are an alphanumeric combination that is unique to your account. The region matches the regional endpoint that you send the request to. This is the endpoint to use for your transcoding requests.

    Important

    If you request your account endpoint programmatically, do so only once in your application. Don't make a request to the public endpoint each time that you make a request to MediaConvert. Otherwise, you will reach the throttle maximum on the public API endpoint.

  4. Send your transcoding requests.

    Using the account endpoint that you received from your POST request, send your requests to manage transcoding jobs, queues, job templates, and presets. For more information, see the following:

    • For information about setting up your transcoding job, see the Creating Your Job Specification topic of this guide.

    • For general information about how the MediaConvert resources (jobs, queues, job templates, and output presets) work, see the AWS Elemental MediaConvert User Guide.

    • For information about interacting programmatically with each resource type, see the Resources topic of this guide.

    • For detailed information about each transcoding setting, see the Properties topic of the Jobs resource chapter of this guide. You might find it easiest to navigate to a particular setting in the Properties topic by following the links in the Schemas section.

    Tip

    If you use Postman to send your requests, you can optionally copy and import the preconfigured AWS Elemental MediaConvert Postman Collection Files.