AWS Elemental MediaLive API Reference
API Reference

Offerings

URI

/prod/offerings

HTTP Methods

GET

Operation ID: ListOfferings

List offerings available for purchase.

Query Parameters

Name Type Required Description
resourceType String False

Filter by resource type, 'INPUT' or 'OUTPUT'

nextToken String False
channelConfiguration String False

Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)

codec String False

Filter by codec, 'AVC', 'HEVC', or 'MPEG2'

videoQuality String False

Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

resolution String False

Filter by resolution, 'SD', 'HD', or 'UHD'

maximumFramerate String False

Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

maxResults String False
maximumBitrate String False

Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

specialFeature String False

Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

Responses

Status Code Response Model Description
200 ListOfferingsResultModel

List of offerings

400 InvalidRequest

This request was invalid.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

403 AccessDenied

You do not have permission to list channels.

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

Schemas

Response Bodies

Example ListOfferingsResultModel

{ "nextToken": "string", "offerings": [ { "duration": integer, "usagePrice": number, "offeringType": enum, "resourceSpecification": { "codec": enum, "maximumFramerate": enum, "resolution": enum, "maximumBitrate": enum, "specialFeature": enum, "resourceType": enum, "videoQuality": enum }, "durationUnits": enum, "offeringDescription": "string", "arn": "string", "offeringId": "string", "region": "string", "fixedPrice": number, "currencyCode": "string" } ] }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AccessDenied

Property Type Required Description
message

string

False

BadGatewayException

Property Type Required Description
message

string

False

GatewayTimeoutException

Property Type Required Description
message

string

False

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

string

False

ListOfferingsResultModel

ListOfferings response

Property Type Required Description
nextToken

string

False

Token to retrieve the next page of results

offerings

Array of type Offering

False

List of offerings

Offering

Reserved resources available for purchase

Property Type Required Description
duration

integer

False

Lease duration, e.g. '12'

usagePrice

number

False

Recurring usage charge for each reserved resource, e.g. '157.0'

offeringType

string

False

Offering type, e.g. 'NO_UPFRONT'

resourceSpecification

ReservationResourceSpecification

False

Resource configuration details

durationUnits

string

False

Units for duration, e.g. 'MONTHS'

offeringDescription

string

False

Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

arn

string

False

Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'

offeringId

string

False

Unique offering ID, e.g. '87654321'

region

string

False

AWS region, e.g. 'us-west-2'

fixedPrice

number

False

One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

currencyCode

string

False

Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

OfferingDurationUnits (enum)

Units for duration, e.g. 'MONTHS'

  • MONTHS

OfferingType (enum)

Offering type, e.g. 'NO_UPFRONT'

  • NO_UPFRONT

ReservationCodec (enum)

Codec, 'MPEG2', 'AVC', or 'HEVC'

  • MPEG2

  • AVC

  • HEVC

  • AUDIO

ReservationMaximumBitrate (enum)

Maximum bitrate in megabits per second

  • MAX_10_MBPS

  • MAX_20_MBPS

  • MAX_50_MBPS

ReservationMaximumFramerate (enum)

Maximum framerate in frames per second (Outputs only)

  • MAX_30_FPS

  • MAX_60_FPS

ReservationResolution (enum)

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines

  • SD

  • HD

  • UHD

ReservationResourceSpecification

Resource configuration (codec, resolution, bitrate, ...)

Property Type Required Description
codec

string

False

Codec, e.g. 'AVC'

maximumFramerate

string

False

Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

resolution

string

False

Resolution, e.g. 'HD'

maximumBitrate

string

False

Maximum bitrate, e.g. 'MAX_20_MBPS'

specialFeature

string

False

Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

resourceType

string

False

Resource type, 'INPUT' or 'OUTPUT'

videoQuality

string

False

Video quality, e.g. 'STANDARD' (Outputs only)

ReservationResourceType (enum)

Resource type, 'INPUT' or 'OUTPUT'

  • INPUT

  • OUTPUT

  • CHANNEL

ReservationSpecialFeature (enum)

Special features, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

  • ADVANCED_AUDIO

  • AUDIO_NORMALIZATION

ReservationVideoQuality (enum)

Video quality, e.g. 'STANDARD' (Outputs only)

  • STANDARD

  • ENHANCED

  • PREMIUM