Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1459758542.7 KB

Get details for a reservation.

get/prod/reservations/{reservationId}

Path parameters

reservationIdstring required

Placeholder documentation for __string

Unique reservation ID, e.g. '1234567'

Response

Success

Arnstring

Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

Countinteger

Number of reserved resources

CurrencyCodestring

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

Durationinteger

Lease duration, e.g. '12'

DurationUnits'MONTHS'

Units for duration, e.g. 'MONTHS'

Endstring

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

FixedPricenumber double

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

Namestring

User specified reservation name

OfferingDescriptionstring

Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

OfferingIdstring

Unique offering ID, e.g. '87654321'

OfferingType'NO_UPFRONT'

Offering type, e.g. 'NO_UPFRONT'

Regionstring

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

ReservationIdstring

Unique reservation ID, e.g. '1234567'

Startstring

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

State'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'DELETED'

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

Tagsobject

A collection of key-value pairs

UsagePricenumber double

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