offerings

Creates, updates, deletes, gets or lists an offerings resource.

Overview

Name	offerings
Type	Resource
Id	aws.mediaconnect.offerings

Fields

The following fields are returned by SELECT queries:

describe_offering

Name	Datatype	Description
currency_code	string	The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
duration	integer	The length of time that your reservation would be active.
duration_units	string	The unit of measurement for the duration of the offering. (MONTHS)
offering_arn	string	The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
offering_description	string	A description of the offering.
price_per_unit	string	The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
price_units	string	The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. (HOURLY)
resource_specification	object	A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.

list_offerings

Name	Datatype	Description
currency_code	string	The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
duration	integer	The length of time that your reservation would be active.
duration_units	string	The unit of measurement for the duration of the offering. (MONTHS)
offering_arn	string	The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
offering_description	string	A description of the offering.
price_per_unit	string	The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
price_units	string	The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. (HOURLY)
resource_specification	object	A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_offering	select	offering_arn, region		Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
list_offerings	select	region	maxResults, nextToken	Displays a list of all offerings that are available to this account in the current Amazon Web Services Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
offering_arn	string	The ARN of the offering.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return per API request. For example, you submit a ListOfferings 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 10 results per page.
nextToken	string	The token that identifies the batch of results that you want to see. For example, you submit a ListOfferings 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 ListOfferings request a second time and specify the NextToken value.

SELECT examples

describe_offering

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

SELECT
currency_code,
duration,
duration_units,
offering_arn,
offering_description,
price_per_unit,
price_units,
resource_specification
FROM aws.mediaconnect.offerings
WHERE offering_arn = '{{ offering_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_offerings

Displays a list of all offerings that are available to this account in the current Amazon Web Services Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

SELECT
currency_code,
duration,
duration_units,
offering_arn,
offering_description,
price_per_unit,
price_units,
resource_specification
FROM aws.mediaconnect.offerings
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;