The Presets API from Amazon MediaConvert — 2 operation(s) for presets.
openapi: 3.0.0
info:
version: 2017-08-29
x-release: v4
title: AWS Elemental MediaConvert Certificates Presets API
description: AWS Elemental MediaConvert
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediaconvert
x-aws-signingName: mediaconvert
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediaconvert-2017-08-29.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mediaconvert.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaConvert multi-region endpoint
- url: https://mediaconvert.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaConvert multi-region endpoint
- url: http://mediaconvert.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaConvert endpoint for China (Beijing) and China (Ningxia)
- url: https://mediaconvert.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaConvert endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Presets
paths:
/2017-08-29/presets:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreatePreset
description: 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
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePresetResponse'
examples:
CreatePreset201Example:
summary: Default CreatePreset 201 response
x-microcks-default: true
value:
Preset: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
CreatePreset480Example:
summary: Default CreatePreset 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreatePreset481Example:
summary: Default CreatePreset 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreatePreset482Example:
summary: Default CreatePreset 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CreatePreset483Example:
summary: Default CreatePreset 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreatePreset484Example:
summary: Default CreatePreset 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
CreatePreset485Example:
summary: Default CreatePreset 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- settings
properties:
category:
description: Optional. A category for the preset you are creating.
type: string
description:
description: Optional. A description of the preset you are creating.
type: string
name:
description: The name of the preset you are creating.
type: string
settings:
description: Settings for preset
type: object
properties:
AudioDescriptions:
allOf:
- $ref: '#/components/schemas/__listOfAudioDescription'
- xml:
name: audioDescriptions
description: (AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.
CaptionDescriptions:
allOf:
- $ref: '#/components/schemas/__listOfCaptionDescriptionPreset'
- xml:
name: captionDescriptions
description: This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.
ContainerSettings:
allOf:
- $ref: '#/components/schemas/ContainerSettings'
- xml:
name: containerSettings
description: Container specific settings.
VideoDescription:
allOf:
- $ref: '#/components/schemas/VideoDescription'
- xml:
name: videoDescription
description: VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec that you choose for the property codec. Include one instance of VideoDescription per output.
tags:
description: The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
summary: Amazon MediaConvert Create Preset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Presets
get:
operationId: ListPresets
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPresetsResponse'
examples:
ListPresets200Example:
summary: Default ListPresets 200 response
x-microcks-default: true
value:
NextToken: example-value
Presets: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
ListPresets480Example:
summary: Default ListPresets 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListPresets481Example:
summary: Default ListPresets 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListPresets482Example:
summary: Default ListPresets 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListPresets483Example:
summary: Default ListPresets 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListPresets484Example:
summary: Default ListPresets 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
ListPresets485Example:
summary: Default ListPresets 485 response
x-microcks-default: true
value: {}
parameters:
- name: category
in: query
required: false
description: Optionally, specify a preset category to limit responses to only presets from that category.
schema:
type: string
- name: listBy
in: query
required: false
description: Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
schema:
type: string
enum:
- NAME
- CREATION_DATE
- SYSTEM
description: Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
- name: maxResults
in: query
required: false
description: Optional. Number of presets, up to twenty, that will be returned at one time
schema:
type: integer
minimum: 1
maximum: 20
- name: nextToken
in: query
required: false
description: Use this string, provided with the response to a previous request, to request the next batch of presets.
schema:
type: string
- name: order
in: query
required: false
description: Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
schema:
type: string
enum:
- ASCENDING
- DESCENDING
description: Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon MediaConvert List Presets
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Presets
/2017-08-29/presets/{name}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeletePreset
description: Permanently delete a preset you have created.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePresetResponse'
examples:
DeletePreset202Example:
summary: Default DeletePreset 202 response
x-microcks-default: true
value: {}
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
DeletePreset480Example:
summary: Default DeletePreset 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeletePreset481Example:
summary: Default DeletePreset 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
DeletePreset482Example:
summary: Default DeletePreset 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
DeletePreset483Example:
summary: Default DeletePreset 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DeletePreset484Example:
summary: Default DeletePreset 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
DeletePreset485Example:
summary: Default DeletePreset 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the preset to be deleted.
schema:
type: string
summary: Amazon MediaConvert Delete Preset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Presets
get:
operationId: GetPreset
description: Retrieve the JSON for a specific preset.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetPresetResponse'
examples:
GetPreset200Example:
summary: Default GetPreset 200 response
x-microcks-default: true
value:
Preset: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
GetPreset480Example:
summary: Default GetPreset 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
GetPreset481Example:
summary: Default GetPreset 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
GetPreset482Example:
summary: Default GetPreset 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
GetPreset483Example:
summary: Default GetPreset 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
GetPreset484Example:
summary: Default GetPreset 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
GetPreset485Example:
summary: Default GetPreset 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the preset.
schema:
type: string
summary: Amazon MediaConvert Get Preset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Presets
put:
operationId: UpdatePreset
description: Modify one of your existing presets.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePresetResponse'
examples:
UpdatePreset200Example:
summary: Default UpdatePreset 200 response
x-microcks-default: true
value:
Preset: example-value
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
examples:
UpdatePreset480Example:
summary: Default UpdatePreset 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdatePreset481Example:
summary: Default UpdatePreset 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
UpdatePreset482Example:
summary: Default UpdatePreset 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
UpdatePreset483Example:
summary: Default UpdatePreset 483 response
x-microcks-default: true
value: {}
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
UpdatePreset484Example:
summary: Default UpdatePreset 484 response
x-microcks-default: true
value: {}
'485':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdatePreset485Example:
summary: Default UpdatePreset 485 response
x-microcks-default: true
value: {}
parameters:
- name: name
in: path
required: true
description: The name of the preset you are modifying.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
category:
description: The new category for the preset, if you are changing it.
type: string
description:
description: The new description for the preset, if you are changing it.
type: string
settings:
description: Settings for preset
type: object
properties:
AudioDescriptions:
allOf:
- $ref: '#/components/schemas/__listOfAudioDescription'
- xml:
name: audioDescriptions
description: (AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.
CaptionDescriptions:
allOf:
- $ref: '#/components/schemas/__listOfCaptionDescriptionPreset'
- xml:
name: captionDescriptions
description: This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.
ContainerSettings:
allOf:
- $ref: '#/components/schemas/ContainerSettings'
- xml:
name: containerSettings
description: Container specific settings.
VideoDescription:
allOf:
- $ref: '#/components/schemas/VideoDescription'
- xml:
name: videoDescription
description: VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec that you choose for the property codec. Include one instance of VideoDescription per output.
summary: Amazon MediaConvert Update Preset
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Presets
components:
schemas:
TimedMetadata:
type: string
enum:
- PASSTHROUGH
- NONE
description: 'Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH) to include ID3 metadata in this output. This includes ID3 metadata from the following features: ID3 timestamp period (timedMetadataId3Period), and Custom ID3 metadata inserter (timedMetadataInsertion). To exclude this ID3 metadata in this output: set ID3 metadata to None (NONE) or leave blank.'
SccDestinationSettings:
type: object
properties:
Framerate:
allOf:
- $ref: '#/components/schemas/SccDestinationFramerate'
- xml:
name: framerate
description: Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).
description: Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.
H265QvbrSettings:
type: object
properties:
MaxAverageBitrate:
allOf:
- $ref: '#/components/schemas/__integerMin1000Max1466400000'
- xml:
name: maxAverageBitrate
description: Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output.
QvbrQualityLevel:
allOf:
- $ref: '#/components/schemas/__integerMin1Max10'
- xml:
name: qvbrQualityLevel
description: Use this setting only when you set Rate control mode (RateControlMode) to QVBR. Specify the target quality level for this output. MediaConvert determines the right number of bits to use for each part of the video to maintain the video quality that you specify. When you keep the default value, AUTO, MediaConvert picks a quality level for you, based on characteristics of your input video. If you prefer to specify a quality level, specify a number from 1 through 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33.
QvbrQualityLevelFineTune:
allOf:
- $ref: '#/components/schemas/__doubleMin0Max1'
- xml:
name: qvbrQualityLevelFineTune
description: Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33.
description: Settings for quality-defined variable bitrate encoding with the H.265 codec. Use these settings only when you set QVBR for Rate control mode (RateControlMode).
Mpeg2RateControlMode:
type: string
enum:
- VBR
- CBR
description: Use Rate control mode (Mpeg2RateControlMode) to specify whether the bitrate is variable (vbr) or constant (cbr).
DeinterlacerMode:
type: string
enum:
- DEINTERLACE
- INVERSE_TELECINE
- ADAPTIVE
description: Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.
AudioNormalizationAlgorithm:
type: string
enum:
- ITU_BS_1770_1
- ITU_BS_1770_2
- ITU_BS_1770_3
- ITU_BS_1770_4
description: 'Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.'
XavcProfile:
type: string
enum:
- XAVC_HD_INTRA_CBG
- XAVC_4K_INTRA_CBG
- XAVC_4K_INTRA_VBR
- XAVC_HD
# --- truncated at 32 KB (562 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/openapi/amazon-mediaconvert-presets-api-openapi.yml