MediaConnect / Client / describe_reservation

describe_reservation#

MediaConnect.Client.describe_reservation(**kwargs)#

Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).

Request Syntax

response = client.describe_reservation(
    ReservationArn='string'
)

Parameters:

ReservationArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the reservation.

Return type:

dict

Returns:

Response Syntax

{
    'Reservation': {
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'End': 'string',
        'OfferingArn': 'string',
        'OfferingDescription': 'string',
        'PricePerUnit': 'string',
        'PriceUnits': 'HOURLY',
        'ReservationArn': 'string',
        'ReservationName': 'string',
        'ReservationState': 'ACTIVE'|'EXPIRED'|'PROCESSING'|'CANCELED',
        'ResourceSpecification': {
            'ReservedBitrate': 123,
            'ResourceType': 'Mbps_Outbound_Bandwidth'
        },
        'Start': 'string'
    }
}

Response Structure

(dict) – MediaConnect returned the reservation details successfully.
- Reservation (dict) – 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.
  - CurrencyCode (string) – The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
  - Duration (integer) – The length of time that this reservation is active. MediaConnect defines this value in the offering.
  - DurationUnits (string) – The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
  - End (string) – 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.
  - OfferingArn (string) – The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
  - OfferingDescription (string) – A description of the offering. MediaConnect defines this value in the offering.
  - PricePerUnit (string) – The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
  - PriceUnits (string) – 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.
  - ReservationArn (string) – The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
  - ReservationName (string) – The name that you assigned to the reservation when you purchased the offering.
  - ReservationState (string) – The status of your reservation.
  - ResourceSpecification (dict) – 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.
    - ReservedBitrate (integer) – The amount of outbound bandwidth that is discounted in the offering.
    - ResourceType (string) – The type of resource and the unit that is being billed for.
  - Start (string) – The day and time that the reservation becomes active. You set this value when you purchase the offering.

Exceptions

MediaConnect.Client.exceptions.NotFoundException
MediaConnect.Client.exceptions.ServiceUnavailableException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.InternalServerErrorException