ListReservations - AWS Elemental MediaConnect

ListReservations

URI

/v1/reservations

HTTP Methods

GET

Operation ID: ListReservations

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all stages (such as active and expired).

Query Parameters
Name Type Required Description
nextToken String False

The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

maxResults String False

The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.

Responses
Status Code Response Model Description
200 ListReservationsResponse

MediaConnect returned the list of reservations successfully.

400 ResponseError

The request that you submitted is not valid.

429 ResponseError

You have exceeded the service request rate limit for your MediaConnect account.

500 ResponseError

MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

MediaConnect is currently unavailable. Try again later.

Schemas

Response Bodies

Example ListReservationsResponse

{ "reservations": [ { "reservationState": enum, "resourceSpecification": { "reservedBitrate": integer, "resourceType": enum }, "start": "string", "durationUnits": enum, "reservationArn": "string", "reservationName": "string", "offeringArn": "string", "pricePerUnit": "string", "duration": integer, "end": "string", "offeringDescription": "string", "priceUnits": enum, "currencyCode": "string" } ], "nextToken": "string" }

Example ResponseError

{ "message": "string" }

Properties

ListReservationsResponse

The result of a successful ListReservations request. The response includes the details of each offering that your account is eligible for. The response includes the following information for each offering: description, duration, outbound bandwidth, price, Amazon Resource Name (ARN), and the NextToken to use in a subsequent ListOfferings request.

Property Type Required Description
reservations

Array of type Reservation

True

A list of all reservations that have been purchased by this account in the current AWS Region.

nextToken

string

False

The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.

Reservation

A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.

Property Type Required Description
reservationState

string

Values: ACTIVE | EXPIRED | INACTIVE

True

The status of your reservation.

resourceSpecification

ResourceSpecification

True

A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.

start

string

True

The day and time that the reservation becomes active. You set this value when you purchase the offering.

durationUnits

string

Values: MONTHS

True

The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.

reservationArn

string

True

The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.

reservationName

string

True

The name that you assigned to the reservation when you purchased the offering.

offeringArn

string

True

The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.

pricePerUnit

string

True

The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.

duration

integer

True

The length of time that this reservation is active. MediaConnect defines this value in the offering.

end

string

True

The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.

offeringDescription

string

True

A description of the offering. MediaConnect defines this value in the offering.

priceUnits

string

Values: HOURLY

True

The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.

currencyCode

string

True

The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.

ResourceSpecification

A definition of what is being billed for, including the type and amount.

Property Type Required Description
reservedBitrate

integer

False

The amount of outbound bandwidth that is discounted in the offering.

resourceType

string

Values: Mbps_Out_To_Internet

True

The type of resource and the unit that is being billed for.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property Type Required Description
message

string

True

The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

See Also

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

ListReservations