reservations

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

Overview

Name	reservations
Type	Resource
Id	aws.medialive.reservations

Fields

The following fields are returned by SELECT queries:

describe_reservation

Name	Datatype	Description
arn	string	Placeholder documentation for __string
count	integer	Placeholder documentation for __integer
currency_code	string	Placeholder documentation for __string
duration	integer	Placeholder documentation for __integer
duration_units	string	Units for duration, e.g. 'MONTHS' (MONTHS)
end	string	Placeholder documentation for __string
fixed_price	number (double)	Placeholder documentation for __double
name	string	Placeholder documentation for __string
offering_description	string	Placeholder documentation for __string
offering_id	string	Placeholder documentation for __string
offering_type	string	Offering type, e.g. 'NO_UPFRONT' (NO_UPFRONT)
region	string	Placeholder documentation for __string
renewal_settings	object	Renewal settings for the reservation
reservation_id	string	Placeholder documentation for __string
resource_specification	object	Resource configuration details
start	string	Placeholder documentation for __string
state	string	Current state of reservation, e.g. 'ACTIVE' (ACTIVE, EXPIRED, CANCELED, DELETED)
tags	object	A collection of key-value pairs
usage_price	number (double)	Placeholder documentation for __double

list_reservations

Name	Datatype	Description
arn	string	Placeholder documentation for __string
count	integer	Placeholder documentation for __integer
currency_code	string	Placeholder documentation for __string
duration	integer	Placeholder documentation for __integer
duration_units	string	Units for duration, e.g. 'MONTHS' (MONTHS)
end	string	Placeholder documentation for __string
fixed_price	number (double)	Placeholder documentation for __double
name	string	Placeholder documentation for __string
offering_description	string	Placeholder documentation for __string
offering_id	string	Placeholder documentation for __string
offering_type	string	Offering type, e.g. 'NO_UPFRONT' (NO_UPFRONT)
region	string	Placeholder documentation for __string
renewal_settings	object	The Renewal settings for Reservations
reservation_id	string	Placeholder documentation for __string
resource_specification	object	Resource configuration details
start	string	Placeholder documentation for __string
state	string	Current state of reservation, e.g. 'ACTIVE' (ACTIVE, EXPIRED, CANCELED, DELETED)
tags	object	A collection of key-value pairs
usage_price	number (double)	Placeholder documentation for __double

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reservation	select	reservation_id, region		Get details for a reservation.
list_reservations	select	region	channelClass, codec, maxResults, maximumBitrate, maximumFramerate, nextToken, resolution, resourceType, specialFeature, videoQuality	List purchased reservations.
update_reservation	update	reservation_id, region		Update reservation.
delete_reservation	delete	reservation_id, region		Delete an expired reservation.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
reservation_id	string	Unique reservation ID, e.g. '1234567'
channelClass	string	Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
codec	string	Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'
maxResults	integer
maximumBitrate	string	Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
maximumFramerate	string	Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
nextToken	string
resolution	string	Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
resourceType	string	Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
specialFeature	string	Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
videoQuality	string	Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

SELECT examples

describe_reservation

Get details for a reservation.

SELECT
arn,
count,
currency_code,
duration,
duration_units,
end,
fixed_price,
name,
offering_description,
offering_id,
offering_type,
region,
renewal_settings,
reservation_id,
resource_specification,
start,
state,
tags,
usage_price
FROM aws.medialive.reservations
WHERE reservation_id = '{{ reservation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_reservations

List purchased reservations.

SELECT
arn,
count,
currency_code,
duration,
duration_units,
end,
fixed_price,
name,
offering_description,
offering_id,
offering_type,
region,
renewal_settings,
reservation_id,
resource_specification,
start,
state,
tags,
usage_price
FROM aws.medialive.reservations
WHERE region = '{{ region }}' -- required
AND channelClass = '{{ channelClass }}'
AND codec = '{{ codec }}'
AND maxResults = '{{ maxResults }}'
AND maximumBitrate = '{{ maximumBitrate }}'
AND maximumFramerate = '{{ maximumFramerate }}'
AND nextToken = '{{ nextToken }}'
AND resolution = '{{ resolution }}'
AND resourceType = '{{ resourceType }}'
AND specialFeature = '{{ specialFeature }}'
AND videoQuality = '{{ videoQuality }}'
;

UPDATE examples

update_reservation

Update reservation.

UPDATE aws.medialive.reservations
SET 
Name = '{{ Name }}',
RenewalSettings = '{{ RenewalSettings }}'
WHERE 
reservation_id = '{{ reservation_id }}' --required
AND region = '{{ region }}' --required
RETURNING
reservation;

DELETE examples

delete_reservation

Delete an expired reservation.

DELETE FROM aws.medialive.reservations
WHERE reservation_id = '{{ reservation_id }}' --required
AND region = '{{ region }}' --required
;