AWS Elemental MediaLive API Reference
API Reference

Offerings offeringId

URI

/prod/offerings/offeringId

HTTP Methods

GET

Operation ID: DescribeOffering

Get details for an offering.

Path Parameters

Name Type Required Description
offeringId String True

Unique offering ID, e.g. '87654321'

Responses

Status Code Response Model Description
200 Offering

Offering details

400 InvalidRequest

This request was invalid.

403 AccessDenied

You do not have permission to list channels.

404 ResourceNotFound

The channel you're requesting to describe does not exist.

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

500 InternalServiceError

Unexpected internal service error.

502 BadGatewayException

Bad Gateway Error

504 GatewayTimeoutException

Gateway Timeout Error

Schemas

Response Bodies

Example Offering

{ "duration": integer, "usagePrice": number, "offeringType": enum, "resourceSpecification": { "codec": enum, "maximumFramerate": enum, "resolution": enum, "maximumBitrate": enum, "specialFeature": enum, "channelClass": 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 ResourceNotFound

{ "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

ChannelClass

A standard channel has two encoding pipelines and a single pipeline channel only has one.

  • STANDARD

  • SINGLE_PIPELINE

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

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

OfferingType

False

Offering type, e.g. 'NO_UPFRONT'

resourceSpecification

ReservationResourceSpecification

False

Resource configuration details

durationUnits

OfferingDurationUnits

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

Units for duration, e.g. 'MONTHS'

  • MONTHS

OfferingType

Offering type, e.g. 'NO_UPFRONT'

  • NO_UPFRONT

ReservationCodec

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

  • MPEG2

  • AVC

  • HEVC

  • AUDIO

ReservationMaximumBitrate

Maximum bitrate in megabits per second

  • MAX_10_MBPS

  • MAX_20_MBPS

  • MAX_50_MBPS

ReservationMaximumFramerate

Maximum framerate in frames per second (Outputs only)

  • MAX_30_FPS

  • MAX_60_FPS

ReservationResolution

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

ReservationCodec

False

Codec, e.g. 'AVC'

maximumFramerate

ReservationMaximumFramerate

False

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

resolution

ReservationResolution

False

Resolution, e.g. 'HD'

maximumBitrate

ReservationMaximumBitrate

False

Maximum bitrate, e.g. 'MAX_20_MBPS'

specialFeature

ReservationSpecialFeature

False

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

channelClass

ChannelClass

False

Channel class, e.g. 'STANDARD'

resourceType

ReservationResourceType

False

Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'

videoQuality

ReservationVideoQuality

False

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

ReservationResourceType

Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'

  • INPUT

  • OUTPUT

  • CHANNEL

ReservationSpecialFeature

Special features, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

  • ADVANCED_AUDIO

  • AUDIO_NORMALIZATION

ReservationVideoQuality

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

  • STANDARD

  • ENHANCED

  • PREMIUM

ResourceNotFound

Property Type Required Description
message

string

False