Offerings: purchase offering
URI
/prod/offerings/offeringId/purchase
HTTP methods
POST
Operation ID: PurchaseOffering
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offeringId | String | True | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | PurchaseOfferingResultModel | 201 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | InvalidRequest | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | AccessDenied | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResourceNotFound | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ResourceConflict | 409 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceeded | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServiceError | 500 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
502 | BadGatewayException | 502 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
504 | GatewayTimeoutException | 504 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Schemas
Request bodies
Response bodies
{ "reservation": { "arn": "string", "count": integer, "currencyCode": "string", "duration": integer, "durationUnits": enum, "end": "string", "fixedPrice": number, "name": "string", "offeringDescription": "string", "offeringId": "string", "offeringType": enum, "region": "string", "reservationId": "string", "resourceSpecification": { "channelClass": enum, "codec": enum, "maximumBitrate": enum, "maximumFramerate": enum, "resolution": enum, "resourceType": enum, "specialFeature": enum, "videoQuality": enum }, "start": "string", "state": enum, "tags": { }, "usagePrice": number } }
{ "message": "string" }
{ "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.
STANDARDSINGLE_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 |
OfferingDurationUnits
Units for duration, e.g. 'MONTHS'
MONTHS
OfferingType
Offering type, e.g. 'NO_UPFRONT'
NO_UPFRONT
PurchaseOffering
PurchaseOffering request
| Property | Type | Required | Description |
|---|---|---|---|
count | integer Minimum: 1 | True | Number of resources |
name | string | False | Name for the new reservation |
requestId | string | False | Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. |
start | string | False | Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now. |
tags | False | A collection of key-value pairs |
PurchaseOfferingResultModel
PurchaseOffering response
| Property | Type | Required | Description |
|---|---|---|---|
reservation | False |
Reservation
Reserved resources available to use
| Property | Type | Required | Description |
|---|---|---|---|
arn | string | False | Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' |
count | integer | False | Number of reserved resources |
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' | |
end | string | False | Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' |
fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering |
name | string | False | User specified reservation name |
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' |
reservationId | string | False | Unique reservation ID, e.g. '1234567' |
resourceSpecification | False | Resource configuration details | |
start | string | False | Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' |
state | False | Current state of reservation, e.g. 'ACTIVE' | |
tags | False | A collection of key-value pairs | |
usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' |
ReservationCodec
Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
MPEG2AVCHEVCAUDIOLINK
ReservationMaximumBitrate
Maximum bitrate in megabits per second
MAX_10_MBPSMAX_20_MBPSMAX_50_MBPS
ReservationMaximumFramerate
Maximum framerate in frames per second (Outputs only)
MAX_30_FPSMAX_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
SDHDFHDUHD
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'
INPUTOUTPUTMULTIPLEXCHANNEL
ReservationSpecialFeature
Special features, 'ADVANCED_AUDIO' 'AUDIO_NORMALIZATION' 'MGHD' or 'MGUHD'
ADVANCED_AUDIOAUDIO_NORMALIZATIONMGHDMGUHD
ReservationState
Current reservation state
ACTIVEEXPIREDCANCELEDDELETED
ReservationVideoQuality
Video quality, e.g. 'STANDARD' (Outputs only)
STANDARDENHANCEDPREMIUM
ResourceConflict
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ResourceNotFound
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
Tags
| Property | Type | Required | Description |
|---|---|---|---|
| string | False |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
PurchaseOffering
