Skip to main content

presets

Creates, updates, deletes, gets or lists a presets resource.

Overview​

Namepresets
TypeResource
Idaws.mediaconvert.presets

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringAn identifier for this resource that is unique within all of AWS.
categorystringAn optional category you create to organize your presets.
created_atstring (date-time)The timestamp in epoch seconds for preset creation.
descriptionstringAn optional description you create for each preset.
last_updatedstring (date-time)The timestamp in epoch seconds when the preset was last updated.
namestringA name you create for each preset. Each name must be unique within your account.
settingsobjectSettings for preset
typestringA preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user. (SYSTEM, CUSTOM)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_presetselectname, regionRetrieve the JSON for a specific preset.
list_presetsselectregioncategory, listBy, maxResults, nextToken, orderRetrieve 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.
create_presetinsertregionCreate a new preset. For information about job templates see the User Guide at http:​//docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
update_presetupdatename, regionModify one of your existing presets.
delete_presetdeletename, regionPermanently delete a preset you have created.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
namestringThe name of the preset to be deleted.
regionstringAWS region (default: us-east-1)
categorystringOptionally, specify a preset category to limit responses to only presets from that category.
listBystringOptional. 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.
maxResultsintegerOptional. Number of presets, up to twenty, that will be returned at one time
nextTokenstringUse this string, provided with the response to a previous request, to request the next batch of presets.
orderstringOptional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

SELECT examples​

Retrieve the JSON for a specific preset.

SELECT
arn,
category,
created_at,
description,
last_updated,
name,
settings,
type
FROM aws.mediaconvert.presets
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

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

INSERT INTO aws.mediaconvert.presets (
Category,
Description,
Name,
Settings,
Tags,
region
)
SELECT 
'{{ Category }}',
'{{ Description }}',
'{{ Name }}',
'{{ Settings }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
preset
;

UPDATE examples​

Modify one of your existing presets.

UPDATE aws.mediaconvert.presets
SET 
Category = '{{ Category }}',
Description = '{{ Description }}',
Settings = '{{ Settings }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
preset;

DELETE examples​

Permanently delete a preset you have created.

DELETE FROM aws.mediaconvert.presets
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;
Last updated on