offerings

Creates, updates, deletes, gets or lists an offerings resource.

Overview

Name	offerings
Type	Resource
Id	aws.medialive.offerings

Fields

The following fields are returned by SELECT queries:

describe_offering

Name	Datatype	Description
arn	string	Placeholder documentation for __string
currency_code	string	Placeholder documentation for __string
duration	integer	Placeholder documentation for __integer
duration_units	string	Units for duration, e.g. 'MONTHS' (MONTHS)
fixed_price	number (double)	Placeholder documentation for __double
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
resource_specification	object	Resource configuration details
usage_price	number (double)	Placeholder documentation for __double

list_offerings

Name	Datatype	Description
arn	string	Placeholder documentation for __string
currency_code	string	Placeholder documentation for __string
duration	integer	Placeholder documentation for __integer
duration_units	string	Units for duration, e.g. 'MONTHS' (MONTHS)
fixed_price	number (double)	Placeholder documentation for __double
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
resource_specification	object	Resource configuration details
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_offering	select	offering_id, region		Get details for an offering.
list_offerings	select	region	channelClass, channelConfiguration, codec, duration, maxResults, maximumBitrate, maximumFramerate, nextToken, resolution, resourceType, specialFeature, videoQuality	List offerings available for purchase.
purchase_offering	exec	offering_id, region, Count		Purchase an offering and create a 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
offering_id	string	Offering to purchase, e.g. '87654321'
region	string	AWS region (default: us-east-1)
channelClass	string	Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
channelConfiguration	string	Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
codec	string	Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', 'LINK', or 'AV1'
duration	string	Filter by offering duration, e.g. '12'
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_offering

Get details for an offering.

SELECT
arn,
currency_code,
duration,
duration_units,
fixed_price,
offering_description,
offering_id,
offering_type,
region,
resource_specification,
usage_price
FROM aws.medialive.offerings
WHERE offering_id = '{{ offering_id }}' -- required
AND region = '{{ region }}' -- required
;

list_offerings

List offerings available for purchase.

SELECT
arn,
currency_code,
duration,
duration_units,
fixed_price,
offering_description,
offering_id,
offering_type,
region,
resource_specification,
usage_price
FROM aws.medialive.offerings
WHERE region = '{{ region }}' -- required
AND channelClass = '{{ channelClass }}'
AND channelConfiguration = '{{ channelConfiguration }}'
AND codec = '{{ codec }}'
AND duration = '{{ duration }}'
AND maxResults = '{{ maxResults }}'
AND maximumBitrate = '{{ maximumBitrate }}'
AND maximumFramerate = '{{ maximumFramerate }}'
AND nextToken = '{{ nextToken }}'
AND resolution = '{{ resolution }}'
AND resourceType = '{{ resourceType }}'
AND specialFeature = '{{ specialFeature }}'
AND videoQuality = '{{ videoQuality }}'
;

Lifecycle Methods

purchase_offering

Purchase an offering and create a reservation.

EXEC aws.medialive.offerings.purchase_offering 
@offering_id='{{ offering_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Count": {{ Count }}, 
"Name": "{{ Name }}", 
"RenewalSettings": "{{ RenewalSettings }}", 
"RequestId": "{{ RequestId }}", 
"Start": "{{ Start }}", 
"Tags": "{{ Tags }}"
}'
;