- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeReservationCommand
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).
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaConnectClient, DescribeReservationCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import
// const { MediaConnectClient, DescribeReservationCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import
const client = new MediaConnectClient(config);
const input = { // DescribeReservationRequest
ReservationArn: "STRING_VALUE", // required
};
const command = new DescribeReservationCommand(input);
const response = await client.send(command);
// { // DescribeReservationResponse
// Reservation: { // Reservation
// CurrencyCode: "STRING_VALUE", // required
// Duration: Number("int"), // required
// DurationUnits: "MONTHS", // required
// End: "STRING_VALUE", // required
// OfferingArn: "STRING_VALUE", // required
// OfferingDescription: "STRING_VALUE", // required
// PricePerUnit: "STRING_VALUE", // required
// PriceUnits: "HOURLY", // required
// ReservationArn: "STRING_VALUE", // required
// ReservationName: "STRING_VALUE", // required
// ReservationState: "ACTIVE" || "EXPIRED" || "PROCESSING" || "CANCELED", // required
// ResourceSpecification: { // ResourceSpecification
// ReservedBitrate: Number("int"),
// ResourceType: "Mbps_Outbound_Bandwidth", // required
// },
// Start: "STRING_VALUE", // required
// },
// };
DescribeReservationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ReservationArn Required | string | undefined | The Amazon Resource Name (ARN) of the offering. |
DescribeReservationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Reservation | Reservation | undefined | 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. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message. |
InternalServerErrorException | server | The server encountered an internal error and is unable to complete the request. |
NotFoundException | client | One or more of the resources in the request does not exist in the system. |
ServiceUnavailableException | server | The service is currently unavailable or busy. |
TooManyRequestsException | client | The request was denied due to request throttling. |
MediaConnectServiceException | Base exception class for all service exceptions from MediaConnect service. |