free_tier_usages
Creates, updates, deletes, gets or lists a free_tier_usages resource.
Overview
| Name | free_tier_usages |
| Type | Resource |
| Id | aws.freetier.free_tier_usages |
Fields
The following fields are returned by SELECT queries:
- get_free_tier_usage
| Name | Datatype | Description |
|---|---|---|
actual_usage_amount | number (double) | Describes the actual usage accrued month-to-day (MTD) that you've used so far. |
description | string | The description of the Free Tier offer. (pattern: <code>[\S\s]*</code>) |
forecasted_usage_amount | number (double) | Describes the forecasted usage by the month that you're expected to use. |
free_tier_type | string | Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free", "Always Free", and "Free Trial". (pattern: <code>[\S\s]*</code>) |
limit | number (double) | Describes the maximum usage allowed in Free Tier. |
operation | string | Describes usageType more granularly with the specific Amazon Web Services service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud. (pattern: <code>[\S\s]*</code>) |
region | string | Describes the Amazon Web Services Region for which this offer is applicable (pattern: <code>[\S\s]*</code>) |
service | string | The name of the Amazon Web Services service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud. (pattern: <code>[\S\s]*</code>) |
unit | string | Describes the unit of the usageType, such as Hrs. (pattern: <code>[\S\s]*</code>) |
usage_type | string | Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial. (pattern: <code>[\S\s]*</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_free_tier_usage | select | region | Returns a list of all Free Tier usage objects that match your filters. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_free_tier_usage
Returns a list of all Free Tier usage objects that match your filters.
SELECT
actual_usage_amount,
description,
forecasted_usage_amount,
free_tier_type,
limit,
operation,
region,
service,
unit,
usage_type
FROM aws.freetier.free_tier_usages
WHERE region = '{{ region }}' -- required
;