- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MediaConvertClient
AWS Elemental MediaConvert
Installation
NPM
npm install @aws-sdk/client-mediaconvert
Yarn
yarn add @aws-sdk/client-mediaconvert
pnpm
pnpm add @aws-sdk/client-mediaconvert
MediaConvertClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AssociateCertificateCommand | Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. |
CancelJobCommand | Permanently cancel a job. Once you have canceled a job, you can't start it again. |
CreateJobCommand | 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 |
CreateJobTemplateCommand | 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 |
CreatePresetCommand | 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 |
CreateQueueCommand | 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 |
DeleteJobTemplateCommand | Permanently delete a job template you have created. |
DeletePolicyCommand | Permanently delete a policy that you created. |
DeletePresetCommand | Permanently delete a preset you have created. |
DeleteQueueCommand | Permanently delete a queue you have created. |
DescribeEndpointsCommand | Send a request with an empty body to the regional API endpoint to get your account API endpoint. Note that DescribeEndpoints is no longer required. We recommend that you send your requests directly to the regional endpoint instead. |
DisassociateCertificateCommand | Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. |
GetJobCommand | Retrieve the JSON for a specific transcoding job. |
GetJobTemplateCommand | Retrieve the JSON for a specific job template. |
GetPolicyCommand | Retrieve the JSON for your policy. |
GetPresetCommand | Retrieve the JSON for a specific preset. |
GetQueueCommand | Retrieve the JSON for a specific queue. |
ListJobTemplatesCommand | 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 |
ListJobsCommand | 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. |
ListPresetsCommand | 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. |
ListQueuesCommand | 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. |
ListTagsForResourceCommand | Retrieve the tags for a MediaConvert resource. |
ListVersionsCommand | Retrieve a JSON array of all available Job engine versions and the date they expire. |
PutPolicyCommand | 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 |
SearchJobsCommand | Retrieve a JSON array that includes job details for up to twenty of your most recent jobs. Optionally filter results further according to input file, queue, or status. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array. |
TagResourceCommand | 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 |
UntagResourceCommand | 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 |
UpdateJobTemplateCommand | Modify one of your existing job templates. |
UpdatePresetCommand | Modify one of your existing presets. |
UpdateQueueCommand | Modify one of your existing queues. |
MediaConvertClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MediaConvertClientConfig