outpost_billing_informations
Creates, updates, deletes, gets or lists an outpost_billing_informations resource.
Overview
| Name | outpost_billing_informations |
| Type | Resource |
| Id | aws.outposts.outpost_billing_informations |
Fields
The following fields are returned by SELECT queries:
- get_outpost_billing_information
| Name | Datatype | Description |
|---|---|---|
begin_date | string (date-time) | The date your subscription starts. |
currency | string | The currency of the subscription price. Currently only USD is supported. (USD) |
end_date | string (date-time) | The date your subscription ends. |
monthly_recurring_price | number (double) | The amount you are billed each month in the subscription period. |
order_ids | array | The order ID for your subscription. |
subscription_id | string | The ID of the subscription that appears on the Amazon Web Services Billing Center console. (pattern: <code>^[\S \n]+$</code>) |
subscription_status | string | The status of subscription which can be one of the following: INACTIVE - Subscription requests that are inactive. ACTIVE - Subscription requests that are in progress and have an end date in the future. PENDING - Subscription has been created but billing has not yet commenced because the subscription begin date has not been reached. CANCELLED - Subscription requests that are cancelled. (ACTIVE, PENDING, INACTIVE, CANCELLED) |
subscription_type | string | The type of subscription which can be one of the following: ORIGINAL - The first order on the Amazon Web Services Outposts. RENEWAL - Renewal requests, both month to month and longer term. CAPACITY_INCREASE - Capacity scaling orders. (ORIGINAL, RENEWAL, CAPACITY_INCREASE) |
upfront_price | number (double) | The amount billed when the subscription is created. This is a one-time charge. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_outpost_billing_information | select | outpost_identifier, region | NextToken, MaxResults | Gets current and historical billing information about the specified Outpost. |
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 |
|---|---|---|
outpost_identifier | string | The ID or ARN of the Outpost. |
region | string | AWS region (default: us-east-1) |
MaxResults | integer | |
NextToken | string |
SELECT examples
- get_outpost_billing_information
Gets current and historical billing information about the specified Outpost.
SELECT
begin_date,
currency,
end_date,
monthly_recurring_price,
order_ids,
subscription_id,
subscription_status,
subscription_type,
upfront_price
FROM aws.outposts.outpost_billing_informations
WHERE outpost_identifier = '{{ outpost_identifier }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;