AWS Elemental MediaLive API Reference
API Reference

Reservations

URI

/prod/reservations

HTTP Methods

GET

Operation ID: ListReservations

List purchased reservations.

Query Parameters

Name Type Required Description
resourceType String False

Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'

nextToken String False
codec String False

Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'

videoQuality String False

Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

resolution String False

Filter by resolution, 'SD', 'HD', or 'UHD'

maximumFramerate String False

Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

channelClass String False

Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

maxResults String False
maximumBitrate String False

Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

specialFeature String False

Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

Responses

Status Code Response Model Description
200 ListReservationsResultModel

List of reservations

400 InvalidRequest

This request was invalid.

403 AccessDenied

You do not have permission to list channels.

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 ListReservationsResultModel

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

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

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

ListReservationsResultModel

ListReservations response

Property Type Required Description
reservations

Array of type Reservation

False

List of reservations

nextToken

string

False

Token to retrieve the next page of results

OfferingDurationUnits

Units for duration, e.g. 'MONTHS'

  • MONTHS

OfferingType

Offering type, e.g. 'NO_UPFRONT'

  • NO_UPFRONT

Reservation

Reserved resources available to use

Property Type Required Description
offeringType

OfferingType

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

OfferingDurationUnits

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

tags

Tags

False

A collection of key-value pairs

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

ReservationState

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

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

ReservationState

Current reservation state

  • ACTIVE

  • EXPIRED

  • CANCELED

  • DELETED

ReservationVideoQuality

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

  • STANDARD

  • ENHANCED

  • PREMIUM

Tags

Property Type Required Description

*

string

False