URI HTTP methods Schemas Properties See also

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


{
  "count": integer,
  "name": "string",
  "requestId": "string",
  "start": "string",
  "tags": {
  }
}

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.

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

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`	Tags	False	A collection of key-value pairs

PurchaseOfferingResultModel

PurchaseOffering response

Property	Type	Required	Description
`reservation`	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`	OfferingDurationUnits	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`	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`	ReservationResourceSpecification	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`	ReservationState	False	Current state of reservation, e.g. 'ACTIVE'
`tags`	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'

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`	ChannelClass	False	Channel class, e.g. 'STANDARD'
`codec`	ReservationCodec	False	Codec, e.g. 'AVC'
`maximumBitrate`	ReservationMaximumBitrate	False	Maximum bitrate, e.g. 'MAX_20_MBPS'
`maximumFramerate`	ReservationMaximumFramerate	False	Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)
`resolution`	ReservationResolution	False	Resolution, e.g. 'HD'
`resourceType`	ReservationResourceType	False	Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
`specialFeature`	ReservationSpecialFeature	False	Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)
`videoQuality`	ReservationVideoQuality	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

ReservationState

Current reservation state

ACTIVE
EXPIRED
CANCELED
DELETED

ReservationVideoQuality

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

STANDARD
ENHANCED
PREMIUM

ResourceConflict

Property	Type	Required	Description
`message`	string	False

ResourceNotFound

Property	Type	Required	Description
`message`	string	False

Offerings: purchase offering

URI

HTTP methods

POST

Schemas

Request bodies

Response bodies

Properties

AccessDenied

BadGatewayException

ChannelClass

GatewayTimeoutException

InternalServiceError

InvalidRequest

LimitExceeded

OfferingDurationUnits

OfferingType

PurchaseOffering

PurchaseOfferingResultModel

Reservation

ReservationCodec

ReservationMaximumBitrate

ReservationMaximumFramerate

ReservationResolution

ReservationResourceSpecification

ReservationResourceType

ReservationSpecialFeature

ReservationState

ReservationVideoQuality

ResourceConflict

ResourceNotFound

Tags

See also

PurchaseOffering