Reservations reservationId - AWS Elemental MediaLive API Reference

Reservations reservationId

URI

/prod/reservations/reservationId

HTTP Methods

GET

Operation ID: DescribeReservation

Get the details for one reservation.

Path Parameters
Name Type Required Description
reservationId String True
Responses
Status Code Response Model Description
200 Reservation

200 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

404 ResourceNotFound

404 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

PUT

Operation ID: UpdateReservation

Create a reservation.

Path Parameters
Name Type Required Description
reservationId String True
Responses
Status Code Response Model Description
200 UpdateReservationResultModel

200 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.

DELETE

Operation ID: DeleteReservation

Delete one reservation.

Path Parameters
Name Type Required Description
reservationId String True
Responses
Status Code Response Model Description
200 Reservation

200 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

Example PUT

{ "name": "string" }

Response Bodies

Example Reservation

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

Example UpdateReservationResultModel

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

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

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'. This element belongs to Offering and Reservtion.

  • NO_UPFRONT

Reservation

Reserved resources available to use. This element belongs to PurchaseOfferingResultMode, and UpdateReservationResultModel.

Property Type Required Description
arn

string

False

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

reservationId

string

False

Unique reservation ID, e.g. '1234567'.

name

string

False

User specified reservation name.

state

ReservationState

False

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

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'.

end

string

False

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

offeringId

string

False

Unique offering ID, e.g. '87654321'.

offeringDescription

string

False

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

resourceSpecification

ReservationResourceSpecification

False

Resource configuration details.

region

string

False

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

offeringType

OfferingType

False

Offering type, e.g. 'NO_UPFRONT'.

duration

integer

False

Lease duration, e.g. '12'.

durationUnits

OfferingDurationUnits

False

Units for duration, e.g. 'MONTHS'.

usagePrice

number

False

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

fixedPrice

number

False

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

currencyCode

string

False

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

tags

Tags

False

A collection of key-value pairs.

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, ...). This element belongs to Offering and Reservtion.

Property Type Required Description
resourceType

ReservationResourceType

False

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'.

codec

ReservationCodec

False

Codec, e.g. 'AVC'.

resolution

ReservationResolution

False

Resolution, e.g. 'HD'.

maximumBitrate

ReservationMaximumBitrate

False

Maximum bitrate, e.g. 'MAX_20_MBPS'.

maximumFramerate

ReservationMaximumFramerate

False

Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only).

videoQuality

ReservationVideoQuality

False

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

specialFeature

ReservationSpecialFeature

False

Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only).

channelClass

ChannelClass

False

Channel class, e.g. 'STANDARD'.

ReservationResourceType

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'.

  • INPUT

  • OUTPUT

  • MULTIPLEX

  • 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

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

Tags

Tags for the resource. This element belongs to many resources belon.

Property Type Required Description

*

string

False

UpdateReservation

UpdateReservation request.

Property Type Required Description
name

string

False

Name of the reservation.

UpdateReservationResultModel

UpdateReservation response.

Property Type Required Description
reservation

Reservation

False

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeReservation

UpdateReservation

DeleteReservation