Offerings: describe offering
URI
/prod/offerings/
offeringId
HTTP methods
GET
Operation ID: DescribeOffering
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offeringId | String | True |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Offering | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | InvalidRequest | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | AccessDenied | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResourceNotFound | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceeded | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServiceError | 500 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
502 | BadGatewayException | 502 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
504 | GatewayTimeoutException | 504 response |
Schemas
Response bodies
{ "arn": "string", "currencyCode": "string", "duration": integer, "durationUnits": enum, "fixedPrice": number, "offeringDescription": "string", "offeringId": "string", "offeringType": enum, "region": "string", "resourceSpecification": { "channelClass": enum, "codec": enum, "maximumBitrate": enum, "maximumFramerate": enum, "resolution": enum, "resourceType": enum, "specialFeature": enum, "videoQuality": enum }, "usagePrice": number }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "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 |
---|---|---|---|
arn | string | False | Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' |
currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' |
duration | integer | False | Lease duration, e.g. '12' |
durationUnits | False | Units for duration, e.g. 'MONTHS' | |
fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering |
offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' |
offeringId | string | False | Unique offering ID, e.g. '87654321' |
offeringType | False | Offering type, e.g. 'NO_UPFRONT' | |
region | string | False | AWS Region, e.g. 'us-west-2' |
resourceSpecification | False | Resource configuration details | |
usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' |
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
LINK
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, FHD is 1080 lines, UHD is greater than 1080 lines
SD
HD
FHD
UHD
ReservationResourceSpecification
Resource configuration (codec, resolution, bitrate, ...)
Property | Type | Required | Description |
---|---|---|---|
channelClass | False | Channel class, e.g. 'STANDARD' | |
codec | False | Codec, e.g. 'AVC' | |
maximumBitrate | False | Maximum bitrate, e.g. 'MAX_20_MBPS' | |
maximumFramerate | False | Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) | |
resolution | False | Resolution, e.g. 'HD' | |
resourceType | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | |
specialFeature | False | Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) | |
videoQuality | False | Video quality, e.g. 'STANDARD' (Outputs only) |
ReservationResourceType
Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
INPUT
OUTPUT
MULTIPLEX
CHANNEL
ReservationSpecialFeature
Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'
ADVANCED_AUDIO
AUDIO_NORMALIZATION
MGHD
MGUHD
ReservationVideoQuality
Video quality, e.g. 'STANDARD' (Outputs only)
STANDARD
ENHANCED
PREMIUM
ResourceNotFound
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: