AWS Elemental MediaLive API Reference
API Reference

Offerings offeringId Purchase

URI

/prod/offerings/ offeringId /purchase

HTTP Methods

POST

Operation ID: PurchaseOffering

Purchase an offering and create a reservation.

Path Parameters

Name Type Required Description
offeringId String True

Unique offering ID, e.g. '87654321'

Responses

Status Code Response Model Description
201 PurchaseOfferingResultModel

Creation of channel is started.

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.

404 ResourceNotFound

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

504 GatewayTimeoutException

Gateway Timeout Error

429 LimitExceeded

Request limit exceeded on list channel calls to channel service.

409 ResourceConflict

The channel is unable to create due to an issue with channel resources.

Schemas

Request Bodies

Example POST

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

Response Bodies

Example PurchaseOfferingResultModel

{ "reservation": { "offeringType": enum, "count": integer, "start": "string", "resourceSpecification": { "codec": enum, "maximumFramerate": enum, "resolution": enum, "maximumBitrate": enum, "specialFeature": enum, "resourceType": enum, "videoQuality": enum }, "durationUnits": enum, "offeringId": "string", "fixedPrice": number, "duration": integer, "usagePrice": number, "reservationId": "string", "name": "string", "end": "string", "state": enum, "offeringDescription": "string", "arn": "string", "region": "string", "currencyCode": "string" } }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

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

OfferingDurationUnits (enum)

Units for duration, e.g. 'MONTHS'

  • MONTHS

OfferingType (enum)

Offering type, e.g. 'NO_UPFRONT'

  • NO_UPFRONT

PurchaseOffering

PurchaseOffering request

Property Type Required Description
requestId

string

False

Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.

count

integer

Minimum: 1

False

Number of resources

name

string

False

Name for the new reservation

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.

PurchaseOfferingResultModel

PurchaseOffering response

Property Type Required Description
reservation

Reservation

False

Reservation

Reserved resources available to use

Property Type Required Description
offeringType

string

False

Offering type, e.g. 'NO_UPFRONT'

count

integer

False

Number of reserved resources

start

string

False

Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

resourceSpecification

ReservationResourceSpecification

False

Resource configuration details

durationUnits

string

False

Units for duration, e.g. 'MONTHS'

offeringId

string

False

Unique offering ID, e.g. '87654321'

fixedPrice

number

False

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

duration

integer

False

Lease duration, e.g. '12'

usagePrice

number

False

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

reservationId

string

False

Unique reservation ID, e.g. '1234567'

name

string

False

User specified reservation name

end

string

False

Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

state

string

False

Current state of reservation, e.g. 'ACTIVE'

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 reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

region

string

False

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

currencyCode

string

False

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

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

ReservationState (enum)

Current reservation state

  • ACTIVE

  • EXPIRED

  • CANCELED

  • DELETED

ReservationVideoQuality (enum)

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