DescribeOffering, PurchaseOffering - AWS Elemental MediaConnect

DescribeOffering, PurchaseOffering

URI

/v1/offerings/offeringArn

HTTP Methods

GET

Operation ID: DescribeOffering

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

Path Parameters
Name Type Required Description
offeringArn String True

The Amazon Resource Name (ARN) of the offering.

Responses
Status Code Response Model Description
200 DescribeOfferingResponse

MediaConnect returned the offering details successfully.

400 ResponseError

The request that you submitted is not valid.

404 ResponseError

MediaConnect did not find the resource that you specified in the request.

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.

POST

Operation ID: PurchaseOffering

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

Path Parameters
Name Type Required Description
offeringArn String True

The Amazon Resource Name (ARN) of the offering.

Responses
Status Code Response Model Description
201 PurchaseOfferingResponse

MediaConnect created the new resource successfully.

400 ResponseError

The request that you submitted is not valid.

403 ResponseError

You don't have the required permissions to perform this operation.

404 ResponseError

MediaConnect did not find the resource that you specified in the request.

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

Request Bodies

Example POST

{ "start": "string", "reservationName": "string" }

Response Bodies

Example DescribeOfferingResponse

{ "offering": { "duration": integer, "resourceSpecification": { "reservedBitrate": integer, "resourceType": enum }, "durationUnits": enum, "offeringDescription": "string", "priceUnits": enum, "currencyCode": "string", "offeringArn": "string", "pricePerUnit": "string" } }

Example PurchaseOfferingResponse

{ "reservation": { "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" } }

Example ResponseError

{ "message": "string" }

Properties

DescribeOfferingResponse

The result of a successful DescribeOffering request.

Property Type Required Description
offering

Offering

True

The offering that you requested a description of.

Offering

A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.

Property Type Required Description
duration

integer

True

The length of time that your reservation would be active.

resourceSpecification

ResourceSpecification

True

A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.

durationUnits

string

Values: MONTHS

True

The unit of measurement for the duration of the offering.

offeringDescription

string

True

A description of 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.

currencyCode

string

True

The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.

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.

PurchaseOfferingRequest

Submits a request to purchase an offering, which creates a reservation in your AWS account. If you already have an active reservation, you can't purchase another offering.

Property Type Required Description
start

string

True

The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive.

Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters.

For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.

reservationName

string

True

The name that you want to use for the reservation.

PurchaseOfferingResponse

The result of a successful PurchaseOffering request.

Property Type Required Description
reservation

Reservation

True

The details of the reservation that you just created when you purchased the offering.

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:

DescribeOffering

PurchaseOffering